Skip to content

Commit

Permalink
Update release guide
Browse files Browse the repository at this point in the history
  • Loading branch information
@lilleyse
lilleyse committed May 11, 2023
1 parent 6a55056 commit 0c5193b
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions docs/release-guide/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This is the process we follow when releasing a new version of Cesium for Omniverse on GitHub.

1. Make sure the latest commit in `main` is passing CI.
2. Download the latest build from S3. In the AWS management console (old AWS account), go to the bucket [`cesium-travis-builds/cesium-omniverse/main`](https://s3.console.aws.amazon.com/s3/buckets/cesium-travis-builds?region=us-east-1&prefix=cesium-omniverse/main/&showversions=false), find the appropriate date and commit hash to download the CentOS and Windows zip files (e.g. `CesiumForOmniverse-Linux-xxxxxxx.zip` and `CesiumForOmniverse-Windows-xxxxxxx.zip` )
2. Download the latest build from S3. In the AWS management console (old AWS account), go to the bucket [`cesium-travis-builds/cesium-omniverse/main`](https://s3.console.aws.amazon.com/s3/buckets/cesium-travis-builds?region=us-east-1&prefix=cesium-omniverse/main/&showversions=false), find the appropriate date and commit hash to download the CentOS and Windows zip files (e.g. `CesiumForOmniverse-Linux-xxxxxxx.zip` and `CesiumForOmniverse-Windows-xxxxxxx.zip`)
3. Verify that the Linux package loads in Omniverse Create (see instructions below).
4. Verify that the Windows package loads in Omniverse Create (see instructions below).
5. Update the project `VERSION` in [CMakeLists.txt](../../CMakeLists.txt).
Expand All @@ -14,28 +14,39 @@ This is the process we follow when releasing a new version of Cesium for Omniver
10. Tag the release, e.g. `git tag -a v0.0.0 -m "0.0.0 release"`.
11. Push the tag, e.g. `git push origin v0.0.0`.
12. Wait for CI to pass.
13. Download the release build from S3. In the AWS management console (old AWS account), go to the bucket [`cesium-travis-builds/cesium-omniverse/main`](https://s3.console.aws.amazon.com/s3/buckets/cesium-travis-builds?region=us-east-1&prefix=cesium-omniverse/main/&showversions=false), find the appropriate date and commit hash to download the CentOS and Windows builds zip files (e.g. `CesiumForOmniverse-Linux-vX.X.X.zip` and `CesiumForOmniverse-Windows-vX.X.X.zip`). Note that the git tag is appended to end of the file name instead of the git commit hash.
14. Create a new release on GitHub: https://github.com/CesiumGS/cesium-omniverse/releases/new.
* Chose the new tag.
* Copy the changelog into the description. Follow the format used in previous releases.
* Upload the Linux and Windows release zip files.
15. Proceed to [Releasing a new version of Cesium for Omniverse Samples](#releasing-a-new-version-of-cesium-for-omniverse-samples).
13. Download the latest build from S3. In the AWS management console (old AWS account), go to the bucket [`cesium-travis-builds/cesium-omniverse/main`](https://s3.console.aws.amazon.com/s3/buckets/cesium-travis-builds?region=us-east-1&prefix=cesium-omniverse/main/&showversions=false), find the appropriate date and commit hash to download the CentOS and Windows zip files (e.g. `CesiumForOmniverse-Linux-xxxxxxx.zip` and `CesiumForOmniverse-Windows-xxxxxxx.zip` )
14. Rename both zip files to use the version number instead of the commit hash, e.g. rename `CesiumForOmniverse-Linux-xxxxxxx.zip` to `CesiumForOmniverse-Linux-v0.0.0.zip` and `CesiumForOmniverse-Windows-xxxxxxx.zip` to `CesiumForOmniverse-Windows-v0.0.0.zip`.
15. Create a new release on GitHub: https://github.com/CesiumGS/cesium-omniverse/releases/new.
* Chose the new tag.
* Copy the changelog into the description. Follow the format used in previous releases.
* Upload the Linux and Windows release zip files.
16. Proceed to [Releasing a new version of Cesium for Omniverse Samples](#releasing-a-new-version-of-cesium-for-omniverse-samples).

# Releasing a new version of Cesium for Omniverse Samples

1. Create a new access token using the CesiumJS ion account.
* The name of the token should match "Cesium for Omniverse Samples vX.X.X - Delete on April 1st, 2023" where the version is the same as the Cesium for Omniverse release and the expiry date is two months later than present.
* The scope of the token should be "assets:read" for all assets.
2. Replace the `cesium:projectDefaultIonAccessToken` property in each `.usda` file with the new access token.
3. Verify that all the USD files load in Cesium for Omniverse.
4. Update `CHANGES.md`.
5. Commit the changes, e.g. `git commit -am "0.0.0 release"`.
6. Push the commit, e.g. `git push origin main`.
7. Tag the release, e.g. `git tag -a v0.0.0 -m "0.0.0 release"`.
8. Push the tag, e.g. `git push origin v0.0.0`.
9. Create a new release on GitHub: https://github.com/CesiumGS/cesium-omniverse-samples/releases/new.
3. Create a new Google Maps API Key in the [Cesium account](https://console.cloud.google.com/google/maps-apis/credentials?project=threed-tiles-api-testing).
* The name of the key should match "Cesium for Omniverse Samples vX.X.X - Delete on April 1st, 2023" where the version is the same as the Cesium for Omniverse release and the expiry date is two months later than present.
* The key should be restricted to the Map Tiles API.
4. For each `.usda` file using the Google 3D Tiles API, replace the key in the `cesium:url` property with the new key.
5. Verify that all the USD files load in Cesium for Omniverse.
6. Update `CHANGES.md`.
7. Commit the changes, e.g. `git commit -am "0.0.0 release"`.
8. Push the commit, e.g. `git push origin main`.
9. Tag the release, e.g. `git tag -a v0.0.0 -m "0.0.0 release"`.
10. Push the tag, e.g. `git push origin v0.0.0`.
11. Download the repo as a zip file.
12. Extract the zip file.
13. Rename the extracted folder, e.g. rename `cesium-omniverse-samples-main` to `CesiumOmniverseSamples-v0.0.0`.
14. Create a zip file of the folder
15. Create a new release on GitHub: https://github.com/CesiumGS/cesium-omniverse-samples/releases/new.
* Choose the new tag.
* Copy the changelog into the description. Follow the format used in previous releases.
* Upload the zip file.


# Verify Package

Expand Down

0 comments on commit 0c5193b

Please sign in to comment.