You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: Documentation/Contributors/ReleaseGuide/README.md
+29-23
Original file line number
Diff line number
Diff line change
@@ -21,37 +21,43 @@ There is no release manager; instead, our community shares the responsibility. A
21
21
3. Make sure you are using the latest drivers for your video card.
22
22
4. Pull down the latest `main` branch.
23
23
5. 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.
24
-
6. Proofread [CHANGES.md](../../../CHANGES.md) with the date of the release. Adjust the order of changes so that prominent/popular changes come first.
25
-
7. Update the version in `package.json` to match, e.g. `1.14.0` -> `1.15.0`.
26
-
8. Commit these changes.
27
-
9. Make sure the repository is clean `git clean -d -x -f`. **This will delete all files not already in the repository.**
28
-
10. Run `npm install`.
29
-
11. Make sure `ThirdParty.json` is up to date by running `npm run build-third-party`. If there are any changes, verify and commit them.
30
-
12. Create the release zip `npm run make-zip`.
31
-
13. Run tests against the release `npm run test -- --failTaskOnError --release`. Test **in all browsers** with the `--browsers` flag (i.e. `--browsers Firefox,Chrome`). Alternatively, test with the browser Spec Runner by starting a local server (`npm start`) and browsing to http://localhost:8080/Specs/SpecRunner.html?built=true&release=true.
32
-
14. Unpack the release zip to the directory of your choice and start the server by running `npm install` and then `npm start`
33
-
15. Browse to http://localhost:8080 and confirm that the home page loads as expected and all links work.
34
-
16. Verify that the [documentation](http://localhost:8080/Build/Documentation/index.html) built correctly
35
-
17. Make sure [Hello World](http://localhost:8080/Apps/HelloWorld.html) loads.
36
-
18. Make sure [Cesium Viewer](http://localhost:8080/Apps/CesiumViewer/index.html) loads.
37
-
19. Run [Sandcastle](http://localhost:8080/Apps/Sandcastle/index.html) on the browser of your choice (or multiple browsers if you are up for it). Switch to the `All` tab and run through every demo to make sure they all work. Actually play with each of the buttons and sliders on each demo to ensure everything works as expected.
38
-
20. If any of the above steps fail, post a message to the `#cesiumjs` channel in Slack to figure out what needs to be fixed before we can release. **Do NOT proceed to the next step until issues are resolved.**
39
-
21. Push your commits to main
24
+
6. 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.
25
+
7. Based on `CHANGES.md`, update each workspace version following the rules of [semantic versioning](https://semver.org/), e.g.,
26
+
-`npm version minor -w @cesium/engine --no-git-tag-version`
27
+
- If there are no changes, skip updating the workspace version.
28
+
8. Update the version in `package.json` to match, e.g. `1.14.0` -> `1.15.0`.
29
+
9. Commit these changes.
30
+
10. Make sure the repository is clean `git clean -d -x -f`. **This will delete all files not already in the repository.**
31
+
11. Run `npm install`.
32
+
12. Make sure `ThirdParty.json` is up to date by running `npm run build-third-party`. If there are any changes, verify and commit them.
33
+
13. Create the release zip `npm run make-zip`.
34
+
14. Run tests against the release `npm run test -- --failTaskOnError --release`. Test **in all browsers** with the `--browsers` flag (i.e. `--browsers Firefox,Chrome`). Alternatively, test with the browser Spec Runner by starting a local server (`npm start`) and browsing to http://localhost:8080/Specs/SpecRunner.html?built=true&release=true.
35
+
15. Unpack the release zip to the directory of your choice and start the server by running `npm install` and then `npm start`
36
+
16. Browse to http://localhost:8080 and confirm that the home page loads as expected and all links work.
37
+
17. Verify that the [documentation](http://localhost:8080/Build/Documentation/index.html) built correctly
38
+
18. Make sure [Hello World](http://localhost:8080/Apps/HelloWorld.html) loads.
39
+
19. Make sure [Cesium Viewer](http://localhost:8080/Apps/CesiumViewer/index.html) loads.
40
+
20. Run [Sandcastle](http://localhost:8080/Apps/Sandcastle/index.html) on the browser of your choice (or multiple browsers if you are up for it). Switch to the `All` tab and run through every demo to make sure they all work. Actually play with each of the buttons and sliders on each demo to ensure everything works as expected.
41
+
21. If any of the above steps fail, post a message to the `#cesiumjs` channel in Slack to figure out what needs to be fixed before we can release. **Do NOT proceed to the next step until issues are resolved.**
42
+
22. Push your commits to main
40
43
-`git push`
41
-
22. Create and push a [tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging), e.g.,
44
+
23. Create and push a [tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging), e.g.,
42
45
-`git tag -a 1.1 -m "1.1 release"`
43
46
-`git push origin 1.1` (this assumes origin is the primary cesium repository, do not use `git push --tags` as it pushes all tags from all remotes you have on your system.)
- Include date, list of highlights and link to CHANGES.md (https://github.com/CesiumGS/cesium/blob/1.xx/CHANGES.md) as the description
49
52
- Look at a [previous release](https://github.com/CesiumGS/cesium/releases/tag/1.79) for an example. Don't use emoji, headings, or other formatting
50
53
- Attach the `Cesium-1.xx` release zip file
51
54
- Publish the release
52
-
24. Publish to npm by running `npm publish` in the repository root (not the unzipped file directory) (the first time you do this, you will need to authorize the machine using `npm adduser`)
53
-
25. Check out the `cesium.com` branch. Merge the new release tag into the `cesium.com` branch `git merge origin <tag-name>`. CI will deploy the hosted release, Sandcastle, and the updated doc when you push the branch up.
54
-
26. After the `cesium.com` branch is live on cesium.com, comment in the `#comms-chat` slack channel to notify comms that the release is done so they can add these highlights and publish the monthly blog post
55
+
25. Publish to npm by running `npm publish` in the repository root (not the unzipped file directory) (the first time you do this, you will need to authorize the machine using `npm adduser`)
56
+
26. Use `npm publish -w <WORKSPACE>` in the repository root (not the unzipped file directory) to publish the workspace. Repeat this step for each **updated** workspace, in the following order:
57
+
-`npm publish -w @cesium/engine`
58
+
-`npm publish -w @cesium/widgets`
59
+
27. Check out the `cesium.com` branch. Merge the new release tag into the `cesium.com` branch `git merge origin <tag-name>`. CI will deploy the hosted release, Sandcastle, and the updated doc when you push the branch up.
60
+
28. After the `cesium.com` branch is live on cesium.com, comment in the `#comms-chat` slack channel to notify comms that the release is done so they can add these highlights and publish the monthly blog post
55
61
- Note, it may take a little while for the new version of CesiumJS to be live on cesium.com (~30 minutes after the branch builds). You can check the version of Cesium in [sandcastle](https://sandcastle.cesium.com/) by looking at the tab above the cesium pane.
56
-
27. Update the version of CesiumJS used in the Cesium Workshop: https://github.com/CesiumGS/cesium-workshop/blob/main/index.html#L13-L14
57
-
28. Continue to the [Cesium Analytics release](https://github.com/CesiumGS/cesium-analytics/blob/main/Documentation/Contributors/AnalyticsReleaseGuide/README.md)
62
+
29. Update the version of CesiumJS used in the Cesium Workshop: https://github.com/CesiumGS/cesium-workshop/blob/main/index.html#L13-L14
63
+
30. Continue to the [Cesium Analytics release](https://github.com/CesiumGS/cesium-analytics/blob/main/Documentation/Contributors/AnalyticsReleaseGuide/README.md)
0 commit comments