Clarify version handling for workspaces in ReleaseGuide #12020
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thank you for the pull request, @jjhembd! ✅ We can confirm we have a CLA on file for you. |
ggetz
reviewed
Jun 4, 2024
| @@ -24,8 +24,9 @@ There is no release manager; instead, our community shares the responsibility. A | |||
| 6. Update the Cesium ion demo token in `Ion.js` with a new token from the CesiumJS ion team account with read and geocode permissions. These tokens are named like this: `1.85 Release - Delete on November 1st, 2021`. Delete the token from 2 releases ago. | |||
| 7. Update the ArcGIS Developer API key in `ArcGisMapService.js` with a new API key from the CesiumJS ArcGIS Developer account. These API keys are named like this: `1.85 Release - Delete on November 1st, 2021`. Delete the API key from the last release. | |||
| 8. Proofread [`CHANGES.md`](../../../CHANGES.md) with the date of the release. Adjust the order of changes so that prominent/popular changes come first. Ensure each change is in the section for the relevant workspace. | |||
| 9. Based on `CHANGES.md`, update each workspace version following the rules of [semantic versioning](https://semver.org/), e.g., | |||
| - `npm version minor -w @cesium/engine --no-git-tag-version` | |||
| 9. Based on `CHANGES.md`, update each workspace version following the rules of [semantic versioning](https://semver.org/), e.g., | |||
There was a problem hiding this comment.
I might also suggest charging the publishing order so that cesium is published after the individual workspaces. That way, we would catch the error with time to change it.
|
Thanks for the suggestion @ggetz! I think this is ready to go now. |
|
Looks good! Thanks @jjhembd! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is a simple clarification for one item in the
ReleaseGuide.During a release, we update versions for each workspace according to semantic versioning, based on the changes in
CHANGES.md. However, ifCHANGES.mdonly lists changes in@cesium/engine, we still need to update the version for@cesium/widgetsto reflect the update in its dependencies.If the dependent workspace version is not updated, the top-level
cesiumand@cesium/widgetswill be pointing to different versions of@cesium/engine. This version conflict can cause build problems for some users.Testing plan
N/A
Author checklist
CONTRIBUTORS.md[ ] I have updatedCHANGES.mdwith a short summary of my change[ ] I have added or updated unit tests to ensure consistent code coverage[ ] I have update the inline documentation, and included code examples where relevant