Update release doc #651
Merged
Update release doc #651
Conversation
This file contains hidden or 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
j9liu
requested changes
Jan 5, 2026
Documentation~/release-guide.md
Outdated
| 6. Create a new release by visiting https://github.com/CesiumGS/cesium-unity/releases/new. | ||
| 7. We haven't created a tag for this release yet, so leave that blank for now. | ||
| 8. Set `Release Title` to "Cesium for Unity v1.21.0", updating the version number as appropriate. | ||
| 9. Copy the "release notes" section from a previous release, which you can find by visiting https://github.com/CesiumGS/cesium-unity/releases/latest and clicking the Edit button. But be careful not to save! |
Contributor
There was a problem hiding this comment.
NIT:
Suggested change
| 9. Copy the "release notes" section from a previous release, which you can find by visiting https://github.com/CesiumGS/cesium-unity/releases/latest and clicking the Edit button. But be careful not to save! | |
| 9. Copy and paste—but do not save!—the "release notes" section from a previous release, which you can find by visiting https://github.com/CesiumGS/cesium-unity/releases/latest and clicking the Edit button. |
| 10. Update the version numbers as appropriate in the top section. Replace the changelog section with the actual changelog entries from this release. Copy it from `CHANGES.md`. | ||
| 11. Upload the .tgz file by dragging it into the "Attach binaries" box. | ||
| 12. Click Save Draft. Be careful not to publish it yet. | ||
|
|
Contributor
There was a problem hiding this comment.
Is it worth also adding Steps 13 + 14 from the Cesium for Unreal guide here, too?
Contributor
There was a problem hiding this comment.
Ah this is a silly comment -- we unzip the file for the tarball, so the SHA can't be compared.
Member
Author
There was a problem hiding this comment.
Yeah I think the best we can do here is make build process output the sha256 of the tgz file before it includes it in the artifact. Then we could compare the value in the log to the sha256 value GitHub shows for the asset to make sure nothing sus has happened.
Documentation~/release-guide.md
Outdated
| * Does it open without crashing? | ||
| * Does it look correct? | ||
| * Press Play. Does it work as expected? The billboard in each level should give you a good idea of what to expect. | ||
| 5. Test on other platforms and other versions of Unity if you can. If you can't (e.g., you don't have a Mac), post a message on Slack asking others to give it at least a quick smoke test. |
Contributor
There was a problem hiding this comment.
NIT:
Suggested change
| 5. Test on other platforms and other versions of Unity if you can. If you can't (e.g., you don't have a Mac), post a message on Slack asking others to give it at least a quick smoke test. | |
| 5. Test on other platforms and other versions of Unity if you can. If you can't (e.g., you don't have a Mac), post a message on Teams asking others to give it at least a quick smoke test. |
Documentation~/release-guide.md
Outdated
| 4. Publish the release as a _draft_, and then go the [releases](https://github.com/CesiumGS/cesium-unity-samples/releases). Download the "Source Code (zip)" asset. Rename it to `CesiumForUnitySamples-v1.2.0.zip`, replacing `v1.2.0` with the correct version number for this release. | ||
| ## Publish the release on GitHub | ||
|
|
||
| 1. Tag the cesium-native release, and push the tag. Be sure you're tagging the exact commit that cesium-unity is using. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Tag the cesium-native release, and push the tag. Be sure you're tagging the exact commit that cesium-unity is using. | |
| 1. Tag the cesium-native release if you haven't already, and push the tag. Be sure you're tagging the exact commit that cesium-unity is using. |
Co-authored-by: Janine Liu <32226860+j9liu@users.noreply.github.com>
This allows us to be sure later that it hasn't changed.
Member
Author
|
I believe I've addressed everything. I added a job at the end of the CI process to print the SHA256 of the .tgz, and updated the instructions to suggest checking it. |
Contributor
|
Thanks @kring ! |
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.
Improved instructions for releasing Cesium for Unity.