Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add releasing guide #121

Merged
merged 2 commits into from
Oct 30, 2021
Merged

Add releasing guide #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
955c037
doc: fix README link typo
ilunglee Oct 30, 2021
99561d7
docs: add releasing guide for maintainers
ilunglee Oct 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,5 +121,18 @@ Adminterface hosts release candidate builds on Github packages. If you wish to t
yarn upgrade @cmdbrew/adminterface@[VERSION]
```

### Releasing (maintainers only)
We use Github Actions to publish releases based on the git tags automatically. See [`.github/workflows/release.yml`](https://github.com/CMDBrew/adminterface/.github/workflows/release.yml) for more information.
1. Update Gem version in [`lib/adminterface/version.rb`](https://github.com/CMDBrew/adminterface/lib/adminterface/version.rb)
2. Update NPM package version in [`package.json`](https://github.com/CMDBrew/adminterface/package.json)
3. Update doc version in [`website/docusaurus.config.js`](https://github.com/CMDBrew/adminterface/website/docusaurus.config.js)
4. Run `yarn release` to update license dependencies
5. Create a tag using git and push it to the repo
```bash
version="v0.x.x"
git tag ${version}
git push origin ${version}
```

## License
By contributing to Adminterface, you agree that your contributions will be licensed under its [License](https://adminterface.io/docs/terms).
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Check our [website](https://adminterface.io) to find in-depth documentation for
See [CONTRIBUTING.md](CONTRIBUTING.md).

## License
Adminterface is free for personal and non-commercial use and with a yearly subscription for commercial purposes. See [our Terms of Service in full text](LICENSE.md) for more information.
Adminterface is free for personal and non-commercial use and with a yearly subscription for commercial purposes. See our [Terms of Service in full text](LICENSE.md) for more information.

### For Commerical License
Get a license at https://adminterface.io/pricing, then create and add the `license_key` into the following file in your project:
Expand Down