Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Post-release doc updates and other miscellanea #5091

Merged
merged 7 commits into from
Mar 19, 2025

Conversation

Manciukic
Copy link
Contributor

@Manciukic Manciukic commented Mar 18, 2025

Changes

  1. Make quickstart guide detect the right CI artifacts depending on the latest release
    • I've tested it locally to make sure it works
  2. Update and improve kernel-policy.md
  3. Fix release note script
  4. Update release policy with 1.11
  5. Move PVH changelog to right section
  6. Update the credits file

Reason

  1. I needed to update the quickstart guide and thought it'd be best to just have it detect the latest versions as we do for the bnaries
  2. There were still references to 4.14
  3. the script wasn't working
  4. it's now being released, wohoo
  5. it was marked as 1.11
  6. for the glory

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • [x]] I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • NA I have mentioned all user-facing changes in CHANGELOG.md.
  • NA If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

We need to manually change what versions our quick start guide points to
at every release. To avoid it getting behind, this change adds automatic
detection of the CI artifacts related to the lastest version (which was
already automatically detected).

This means that CI artifacts will not point to the latest available but
they will be the same we use to test the latest release, to ensure
compatibility and that the guide always works.

Signed-off-by: Riccardo Mancini <mancio@amazon.com>
Copy link

codecov bot commented Mar 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.14%. Comparing base (888c5f3) to head (829781c).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5091   +/-   ##
=======================================
  Coverage   83.14%   83.14%           
=======================================
  Files         248      248           
  Lines       26923    26923           
=======================================
  Hits        22386    22386           
  Misses       4537     4537           
Flag Coverage Δ
5.10-c5n.metal 83.53% <ø> (ø)
5.10-m5n.metal 83.51% <ø> (+<0.01%) ⬆️
5.10-m6a.metal 82.70% <ø> (ø)
5.10-m6g.metal 79.56% <ø> (ø)
5.10-m6i.metal 83.51% <ø> (+<0.01%) ⬆️
5.10-m7a.metal-48xl 82.71% <ø> (?)
5.10-m7g.metal 79.56% <ø> (ø)
6.1-c5n.metal 83.57% <ø> (ø)
6.1-m5n.metal 83.56% <ø> (ø)
6.1-m6a.metal 82.75% <ø> (ø)
6.1-m6g.metal 79.56% <ø> (-0.01%) ⬇️
6.1-m6i.metal 83.55% <ø> (-0.01%) ⬇️
6.1-m7a.metal-48xl 82.75% <ø> (?)
6.1-m7g.metal 79.56% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Manciukic Manciukic marked this pull request as ready for review March 18, 2025 14:04
Copy link
Contributor

@roypat roypat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validated the new getting started guide works on my laptop 🎉

@Manciukic Manciukic added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Mar 18, 2025
The current wording is unclear since all kernel versions seem to be
expired or to expire this year. This commit attempts to make it clear
that 2 versions will always be supported.

Furthermore, any reference to 4.14 is removed.

Signed-off-by: Riccardo Mancini <mancio@amazon.com>
We changed the markdown format of CHANGELOG.md to not have escapes for
the square brackets, so the tool broke.
This commit fixes it.

Signed-off-by: Riccardo Mancini <mancio@amazon.com>
@Manciukic Manciukic force-pushed the v1.12-dev/update-docs branch 2 times, most recently from a38be69 to b2276da Compare March 18, 2025 14:56
Add 1.11 to the release policy and mark 1.9 as unsupported.

Signed-off-by: Riccardo Mancini <mancio@amazon.com>
It was incorrectly marked as released in 1.11.0.

Signed-off-by: Riccardo Mancini <mancio@amazon.com>
This commit updates the CREDITS.md file to be in sync with the new
release v1.11.0

Signed-off-by: Riccardo Mancini <mancio@amazon.com>
@Manciukic Manciukic force-pushed the v1.12-dev/update-docs branch from b2276da to fbe0763 Compare March 18, 2025 15:22
@Manciukic Manciukic enabled auto-merge (rebase) March 19, 2025 09:24
Copy link
Contributor

@xmarcalx xmarcalx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for the changes.

@Manciukic Manciukic merged commit 70d6e7f into firecracker-microvm:main Mar 19, 2025
7 checks passed
@Manciukic Manciukic deleted the v1.12-dev/update-docs branch March 19, 2025 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Awaiting review Indicates that a pull request is ready to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants