Skip to content

Commit

Permalink
[Docs] Backporting documentation improvements (#5217)
Browse files Browse the repository at this point in the history
* Fix error npm publish tag command

* Add note about node.js versions error

* nit: fix code block syntax issue
  • Loading branch information
Constance authored Sep 27, 2021
1 parent 765c827 commit 7d1bbc5
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions wiki/releasing-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ This provides a walkthrough of the patching & backport release process; examples
* in the EUI git repo, checkout the release tag the patch is intended for - `git checkout v22.3.0`
* create a new branch from the versioned tag, the name is unimportant but I use the target version without a leading `v` - `git checkout -b 22.3.1`
* Run `yarn` to ensure you have the correct dependencies for that point in time installed
* If you run into an error about `nodegit.node` being compiled against a different version of Node.js, try running `rm -rf node_modules && yarn`
* Apply the commit(s) with the desired changes
* GitHub issue references #3369, #3378, #3330, and #3398
* We always use squash merges, so each PR has a single commit hash to include
Expand All @@ -78,9 +79,9 @@ This provides a walkthrough of the patching & backport release process; examples
* Push the version commit & tag to upstream - `git push upstream --tags`
* Publish the new version to npm
* Get your npm One Time Password (OTP) from Google Authenticator, Authy, etc
* Publish with your OPT and the new version as the tag - `npm publish --tag=22.3.1 --otp=your-one-time-password`
* Publish with your OPT and the new version as the tag - `npm publish --tag=backport --otp=your-one-time-password`
* Update `master`'s changelog to include this release
* On the branch you used to build & release, copy the relevant changelog section - e.g. contents of `## [`22.3.1`](https://github.com/elastic/eui/tree/v22.3.1)`
* On the branch you used to build & release, copy the relevant changelog section - e.g. contents of ```## [`22.3.1`](https://github.com/elastic/eui/tree/v22.3.1)```
* Checkout `master` - `git checkout master`
* Paste the changelog section at the correct location in _CHANGELOG.md_
* Include an extra line at the top of this section describing it as a backport, e.g. **Note: this release is a backport containing changes originally made in `23.0.0`, `23.1.0`, and `23.2.0`**
Expand Down

0 comments on commit 7d1bbc5

Please sign in to comment.