The release process is started by running the following command.
npm run release
This command runs all tests and then builds the lib
and dist
distributions formats. Next the recent changes are read from CHANGELOG.md
and you will be asked to choose what part of the version to bump.
After the version is bumped, the release script automatically updates CHANGELOG.md
to note that the recent changes are now part of a release. The updates are committed to git and tagged, then pushed to your upstream
branch.
The command will prompt you for your git credentials. If you are using 2FA for git (which you should be) then your git password must be a one time token.
That's it. The latest changes were published to GitHub, a new git
tag now exists on GitHub, the new release can be installed from npm
, and the documentation site will update momentarily*.
* GitHub Pages sites are cached aggressively and can sometimes take a couple of minutes to update.
@elastic/eslint-plugin-eui
For information on releasing the eslint plugin checkout the readme in packages/eslint-plugin/README.md
In general, we strongly encourage updating to the latest version of EUI to obtain bug fixes, and we do not actively consider backporting fixes to previous major or minor release versions. The exception to this is when supporting Kibana's release process, as we want to avoid pushing larger changes near the feature freeze.
When preparing for a backport a GitHub issue should be created in EUI referencing the relevant issues and/or PRs to be included - see https://github.com/elastic/eui/issues/3386 as an example. This issue is used to keep track of the patch's completion progress and to ensure the desired changes are included in the release.
This provides a walkthrough of the patching & backport release process; examples are taken from the release of v22.3.1 based on https://github.com/elastic/eui/issues/3386
master
branch. This ensures the changelog is prepared for referencing later by the backport, and pulls in all commits that will be used by the backport.
master
- git checkout master
npm run release
22.3.1
and I confirmed the patch's base is 22.3.0
git checkout v22.3.0
v
- git checkout -b 22.3.1
yarn
to ensure you have the correct dependencies for that point in time installed797057a
as the commit hash797057a
, 9ba25c0
, 68080d2
, and 42c7ced
git cherry-pick 797057a 9ba25c0 68080d2 42c7ced
22.3.0
's side in this example) and adding the cherry-picked entry to the master
headinggit cherry-pick --continue
until all commits have been appliedyarn start
yarn release
script only works when releasing from master
, so we'll run a subset of those steps manually
npm test
npm run build
npm run update-token-changelog -- patch
npm version patch
git push upstream --tags
npm publish --tag=22.3.1 --otp=your-one-time-password
master
's changelog to include this release
## [
22.3.1](https://github.com/elastic/eui/tree/v22.3.1)
master
- git checkout master
23.0.0
, 23.1.0
, and 23.2.0
git commit -anm "changelog" && git push
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。