Skip to content

Commit 70c6516

Browse files
committed
docs(readme): update publishing section
1 parent cb6bd25 commit 70c6516

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -239,14 +239,16 @@ Use default active_admin theme.
239239

240240
## Publishing
241241

242-
On master/main branch...
243-
244-
1. Change `VERSION` in `lib/activeadmin_addons/version.rb`.
245-
2. Change `Unreleased` title to current version in `CHANGELOG.md`.
246-
3. Run `bundle install`.
247-
4. Commit new release. For example: `Releasing v1.0.0`.
248-
5. Create tag. For example: `git tag v1.0.0`.
249-
6. Push tag. For example: `git push origin v1.0.0`.
242+
On a new branch:
243+
244+
1. Change `VERSION` in `lib/activeadmin_addons/version.rb`. Note that beta versions should have a `.beta` suffix (e.g. `1.0.0.beta.1`).
245+
2. Change `"version"` in `package.json` to the same version. Note that beta versions should have a `-beta` suffix (e.g. `1.0.0-beta.1`).
246+
3. Change `Unreleased` title to current version in `CHANGELOG.md`.
247+
4. Run `bundle install`.
248+
5. Open a new PR with those changes.
249+
6. Once the PR is merged, checkout to master and pull the changes.
250+
8. Create tag. For example: `git tag v1.0.0`.
251+
9. Push tag. For example: `git push origin v1.0.0`. This will trigger the CI to publish the new version to npm and rubygems.
250252

251253
## Contributing
252254

0 commit comments

Comments
 (0)