Skip to content

chore(docs): update getting-started.md with new artifact system#5950

Open
JamesC1305 wants to merge 1 commit into
firecracker-microvm:mainfrom
JamesC1305:chore/update-getting-started-ci-artifacts
Open

chore(docs): update getting-started.md with new artifact system#5950
JamesC1305 wants to merge 1 commit into
firecracker-microvm:mainfrom
JamesC1305:chore/update-getting-started-ci-artifacts

Conversation

@JamesC1305

Copy link
Copy Markdown
Contributor

Changes

Update docs for retrieving latest artifacts. Previously artifacts were released with each new release. Now, we no longer build artifacts on release, opting to build them weekly instead. Update the docs to fetch the latest YYYYMMDD artifact build instead now.

Reason

Issue #5945 reported artifacts missing following getting started guide. Building artifacts is not part of our release process, so instead of adding them there retrospectively, we should update documentation accordingly.

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 checkbuild --all to verify that the PR passes
    build checks on all supported architectures.
  • 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.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • 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 used to release new artifacts with every release, so it was
sufficient to pull artifacts from
s3://spec.ccfc.min/firecracker-ci/vX.Y.Z. Instead of this, we now build
artifacts every week. Update docs to fetch the artifacts with latest
date instead.

Signed-off-by: James Curtis <jxcurtis@amazon.com>
@JamesC1305 JamesC1305 added the Status: Awaiting review Indicates that a pull request is ready to be reviewed label Jun 10, 2026
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.00%. Comparing base (d300fd2) to head (5afbb3d).
⚠️ Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5950   +/-   ##
=======================================
  Coverage   83.00%   83.00%           
=======================================
  Files         277      277           
  Lines       30106    30106           
=======================================
  Hits        24989    24989           
  Misses       5117     5117           
Flag Coverage Δ
5.10-m5n.metal 83.30% <ø> (ø)
5.10-m6a.metal 82.65% <ø> (ø)
5.10-m6g.metal 79.94% <ø> (ø)
5.10-m6i.metal 83.30% <ø> (ø)
5.10-m7a.metal-48xl 82.64% <ø> (+<0.01%) ⬆️
5.10-m7g.metal 79.94% <ø> (ø)
5.10-m7i.metal-24xl 83.28% <ø> (ø)
5.10-m7i.metal-48xl 83.28% <ø> (ø)
5.10-m8g.metal-24xl 79.94% <ø> (-0.01%) ⬇️
5.10-m8g.metal-48xl 79.94% <ø> (ø)
5.10-m8i.metal-48xl 83.27% <ø> (ø)
5.10-m8i.metal-96xl 83.28% <ø> (ø)
6.1-m5n.metal 83.33% <ø> (ø)
6.1-m6a.metal 82.67% <ø> (ø)
6.1-m6g.metal 79.94% <ø> (ø)
6.1-m6i.metal 83.33% <ø> (+<0.01%) ⬆️
6.1-m7a.metal-48xl 82.67% <ø> (+<0.01%) ⬆️
6.1-m7g.metal 79.94% <ø> (ø)
6.1-m7i.metal-24xl 83.34% <ø> (-0.01%) ⬇️
6.1-m7i.metal-48xl 83.34% <ø> (ø)
6.1-m8g.metal-24xl 79.94% <ø> (ø)
6.1-m8g.metal-48xl 79.94% <ø> (ø)
6.1-m8i.metal-48xl 83.34% <ø> (ø)
6.1-m8i.metal-96xl 83.34% <ø> (-0.01%) ⬇️
6.18-m5n.metal 83.33% <ø> (+<0.01%) ⬆️
6.18-m6a.metal 82.67% <ø> (-0.01%) ⬇️
6.18-m6g.metal 79.94% <ø> (-0.01%) ⬇️
6.18-m6i.metal 83.33% <ø> (ø)
6.18-m7a.metal-48xl 82.66% <ø> (ø)
6.18-m7g.metal 79.94% <ø> (-0.01%) ⬇️
6.18-m7i.metal-24xl 83.34% <ø> (-0.01%) ⬇️
6.18-m7i.metal-48xl 83.34% <ø> (-0.01%) ⬇️
6.18-m8g.metal-24xl 79.94% <ø> (ø)
6.18-m8g.metal-48xl 79.94% <ø> (ø)
6.18-m8i.metal-48xl 83.34% <ø> (ø)
6.18-m8i.metal-96xl 83.34% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

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.

2 participants