Skip to content

Commit

Permalink
Update / modernize publishing docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
theengineear committed Feb 29, 2024
1 parent a5097f0 commit a8017d3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

We use GitHub actions to publish new versions of this repository. To publish, perform the following actions:

1. Checkout the `main` branch and `pull` to ensure your local branch is current — `git checkout main && git pull origin main`
2. Run `npm version` and select the next version number (being careful to differentiate between releases and release candidates) — `npm version`
3. Push the resulting commit to the origin's `main` branch — `git push origin main`
4. Push the resulting tags to origin — `git push origin --tags`
5. In the GitHub UI, find [the tag you just pushed](https://github.com/Netflix/x-element/tags) and find the "Create release" option.
6. Add any additional release information (including to check the box if it's a "pre-release", it probably is!).
1. Ensure your local `main` branch is checked-out and current — `git checkout main && git pull origin main`.
2. Run `npm version` to view the current version. Then…
* **For Normal Releases** use a keyword like `major`, `minor`, or `patch` keywords (e.g., `npm version patch`).
* **For Release Candidates** manually declare the next version (e.g., `npm version 1.0.0-rc.57`).
3. Push the resulting commit and tags`git push origin main --follow-tags`.
4. In the GitHub UI, find [the tag you just pushed](https://github.com/Netflix/x-element/tags) and find the "Create release" option. Add any additional release information (including to check the box if it's a "pre-release", it probably is!).

By _creating a release_, the "Release" GitHub action will be triggered and if all the tests pass, it'll publish.
By _creating a release_, the "Publish" GitHub action will be triggered and if all the tests pass, itll publish to all the registries we care about.

0 comments on commit a8017d3

Please sign in to comment.