Skip to content

(maint) add CONTRIBUTING.md documentation #560

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

Merged
merged 1 commit into from
Sep 10, 2024
Merged

(maint) add CONTRIBUTING.md documentation #560

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Releasing a new cli version

- Make sure that main is green before proceeding! Then in the CLI directory, update to latest.

```shell
git fetch --all
git rebase origin/main
```

- Compare the changes from the last release to what is in main. For [example](https://github.com/overmindtech/cli/compare/v1.3.2...main). Following [semver](https://semver.org/) choose your new version. And use it to tag a version, and push it.

```shell
git tag v0.0.0
git push origin tag v0.0.0
```

- Github actions will then run, assuming everything goes green. It will create a new [pull request in overmind/homebrew-overmind](https://github.com/overmindtech/homebrew-overmind/pulls).
- **DO NOT MERGE THE PR YET** If this PR is green the PR it will require the 'pr-pull' label to be added. It will trigger another github action / check to run. This will automerge the PR and the release is complete.