Skip to content

Commit

Permalink
docs(readme): update publishing section
Browse files Browse the repository at this point in the history
  • Loading branch information
difernandez committed Jun 9, 2023
1 parent cb6bd25 commit 70c6516
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,14 +239,16 @@ Use default active_admin theme.

## Publishing

On master/main branch...

1. Change `VERSION` in `lib/activeadmin_addons/version.rb`.
2. Change `Unreleased` title to current version in `CHANGELOG.md`.
3. Run `bundle install`.
4. Commit new release. For example: `Releasing v1.0.0`.
5. Create tag. For example: `git tag v1.0.0`.
6. Push tag. For example: `git push origin v1.0.0`.
On a new branch:

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`).
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`).
3. Change `Unreleased` title to current version in `CHANGELOG.md`.
4. Run `bundle install`.
5. Open a new PR with those changes.
6. Once the PR is merged, checkout to master and pull the changes.
8. Create tag. For example: `git tag v1.0.0`.
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.

## Contributing

Expand Down

0 comments on commit 70c6516

Please sign in to comment.