Skip to content

Commit 4b1b05f

Browse files
committed
Formatting fix
1 parent f7f441b commit 4b1b05f

File tree

1 file changed

+18
-14
lines changed
  • Documentation/Contributors/ReleaseGuide

1 file changed

+18
-14
lines changed

Documentation/Contributors/ReleaseGuide/README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,34 @@ There is no one release manager; instead, [our community shares the responsibili
1717
## One week before release
1818

1919
1. **Update outdated npm dependencies.**
20-
- List outdated dependencies with [`npm outdated`](https://docs.npmjs.com/cli/v8/commands/npm-outdated):
21-
- Run `npm install`, then `npm outdated`.
22-
- For each outdated dependency, if any:
23-
- Check against the [`dependencies` label](https://github.com/CesiumGS/cesium/issues?q=is%3Aissue+is%3Aopen+label%3Adependencies) for any known compatability issues or specifics on pinned versions. Skip the dependency update if it is still incompatable.
24-
- To increment a dependency, checkout a new branch. Run `npm install <packagename>@latest` and verify the update.
25-
- If an update is incompatible, open a new issue tagged with the `dependencies` label.
26-
- If an update can be resolved, commit the changes and open a PR for review.
20+
- List outdated dependencies with [`npm outdated`](https://docs.npmjs.com/cli/v8/commands/npm-outdated):
21+
- Run `npm install`, then `npm outdated`.
22+
- For each outdated dependency, if any:
23+
- Check against the [`dependencies` label](https://github.com/CesiumGS/cesium/issues?q=is%3Aissue+is%3Aopen+label%3Adependencies) for any known compatability issues or specifics on pinned versions. Skip the dependency update if it is still incompatible.
24+
- To increment a dependency, checkout a new branch. Run `npm install <packagename>@latest` and verify the update.
25+
- If an update is incompatible, open a new issue tagged with the `dependencies` label.
26+
- If an update can be resolved, commit the changes and open a PR for review.
2727

2828
> [!IMPORTANT]
29-
> We pin an exact version of **`prettier`**. If the version of `prettier` should be incremented, use an exact version by running `npm install prettier@latest --save-exact`.
30-
>
29+
> We pin an exact version of **`prettier`**. If the version of `prettier` should be incremented, use an exact version by running `npm install prettier@latest --save-exact`.
30+
>
3131
> If you run `npm install prettier@latest` without the `--save-exact` argument, remove the `^` in `package.json`.
3232
>
3333
> It's reccomended to commit the package update and a seperate commit for any automated formatting updates to streamline PR reviews.
34-
34+
35+
<!-- markdownlint-disable MD029 -->
36+
3537
2. **Check the [`priority - next release` issues and PRs](https://github.com/CesiumGS/cesium/labels/priority%20-%20next%20release).** Work with the team to ensure accountability for priority items—This can be done via the "CesiumJS" channel in Teams.
36-
- Ask the team if there are any items not tagged with the `priority - next release` label which should be.
37-
- Any outstanding items, post a message to the to figure out what needs to be addressed before we can release.
38+
- Ask the team if there are any items not tagged with the `priority - next release` label which should be.
39+
- Any outstanding items, post a message to the to figure out what needs to be addressed before we can release.
3840
3. **Check the [`remove in <version number>` issues](https://github.com/CesiumGS/cesium/labels?q=remove).**
39-
- Search the codebase for any scheduled deprecations and ensure a corresponding tagged issue exists.
40-
- Open a PR to address each items scheduled for removal in the next release, if any.
41+
- Search the codebase for any scheduled deprecations and ensure a corresponding tagged issue exists.
42+
- Open a PR to address each items scheduled for removal in the next release, if any.
4143
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`.
4244
5. Start thinking ahead for a good image for the release blog post in case you need to prepare any data, assets, or examples.
4345

46+
<!-- markdownlint-enable MD029 -->
47+
4448
## Release testing and packaging
4549

4650
> [!IMPORTANT]

0 commit comments

Comments
 (0)