Skip to content

Release guide refreshes#13181

Merged
mzschwartz5 merged 3 commits intomainfrom
release-guide-updates
Feb 12, 2026
Merged

Release guide refreshes#13181
mzschwartz5 merged 3 commits intomainfrom
release-guide-updates

Conversation

@ggetz
Copy link
Contributor

@ggetz ggetz commented Feb 2, 2026

Description

Refreshes the release guide with:

  • Additional formatting so the previously dense list of steps is (hopefully) easier to process and scan
  • More context and specifics in light of recent, minor process shifts
  • Polish and clarity tweaks, including typos, grammar fixes, and minor rewording

There are no fundamental changes to our existing processes here—This should be a documentation-only review.

Feedback welcome if anything feels less clear or people don't like my formatting 😄

Issue number and link

N/A

Testing plan

Read the updated Release Guide

Author checklist

  • I have submitted a Contributor License Agreement
  • I have added my name to CONTRIBUTORS.md
  • I have updated CHANGES.md with a short summary of my change
  • I have added or updated unit tests to ensure consistent code coverage
  • I have updated the inline documentation, and included code examples where relevant
  • I have performed a self-review of my code

@github-actions
Copy link

github-actions bot commented Feb 2, 2026

Thank you for the pull request, @ggetz!

✅ We can confirm we have a CLA on file for you.

@ggetz
Copy link
Contributor Author

ggetz commented Feb 2, 2026

@mzschwartz5 or @jjhembd, could you please review?

- If an update is incompatible, open a new issue tagged with the `dependencies` label.
- If an update can be resolved, commit the changes and open a PR for review.
- Check against the [`dependencies` label](https://github.com/CesiumGS/cesium/issues?q=is%3Aissue+is%3Aopen+label%3Adependencies) for any known compatibility issues or specifics on pinned versions. Skip the dependency update if it is still incompatible.
- To increment a dependency, check out a new branch. Run `npm install <packagename>@latest` and verify the update.
Copy link
Contributor

Choose a reason for hiding this comment

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

This kind of makes it sound like each dependency update should get its own branch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fair, updated to make this a bit clearer.

- Search the codebase for any versioned deprecations and, if present, ensure a corresponding tagged issue exists for each
- Open a PR to address each item scheduled for removal in the next release, if any

4. Ensure you've generated valid [end-to-end testing snapshots](../TestingGuide/README.md) against a previous release tag with `npm run test-e2e-update`
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this happen before or after updating npm packages?

@mzschwartz5
Copy link
Contributor

Looks good to me, just had one or two questions/comments.

@ggetz
Copy link
Contributor Author

ggetz commented Feb 12, 2026

Thanks @mzschwartz5! Updated!

@mzschwartz5 mzschwartz5 added this pull request to the merge queue Feb 12, 2026
Merged via the queue into main with commit b63a3a4 Feb 12, 2026
4 of 5 checks passed
@mzschwartz5 mzschwartz5 deleted the release-guide-updates branch February 12, 2026 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants