-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
workflows: update branch target to main
- Loading branch information
Showing
9 changed files
with
27 additions
and
65 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,7 @@ contributors, the general procedure for contributing has been established: | |
make a comment on the issue to inform the community of your intentions | ||
to begin work | ||
4. Follow standard Github best practices: fork the repo, branch from the | ||
HEAD of `master`, make some commits, and submit a PR to `master` | ||
HEAD of `main`, make some commits, and submit a PR to `main` | ||
- For core developers working within the cosmos-sdk repo, to ensure a clear | ||
ownership of branches, branches must be named with the convention | ||
`{moniker}/{issue#}-branch-name` | ||
|
@@ -105,13 +105,13 @@ For instance, to create a fork and work on a branch of it, I would: | |
- `git remote add origin [email protected]:rigeyrigerige/Sommelier.git` | ||
|
||
Now `origin` refers to my fork and `upstream` refers to the Sommelier version. | ||
So I can `git push -u origin master` to update my fork, and make pull requests to Sommelier from there. | ||
So I can `git push -u origin main` to update my fork, and make pull requests to Sommelier from there. | ||
Of course, replace `rigeyrigerige` with your git handle. | ||
|
||
To pull in updates from the origin repo, run | ||
|
||
- `git fetch upstream` | ||
- `git rebase upstream/master` (or whatever branch you want) | ||
- `git rebase upstream/main` (or whatever branch you want) | ||
|
||
Please don't make Pull Requests to `main`. | ||
|
||
|
@@ -171,39 +171,39 @@ Sommelier utilizes [semantic versioning](https://semver.org/). | |
Ensure that you base and target your PR on the `main` branch. | ||
All feature additions should be targeted against `master`. Bug fixes for an outstanding release candidate | ||
All feature additions should be targeted against `main`. Bug fixes for an outstanding release candidate | ||
should be targeted against the release candidate branch. Release candidate branches themselves should be the | ||
only pull requests targeted directly against master. | ||
only pull requests targeted directly against main. | ||
### Development Procedure | ||
- the latest state of development is on `master` | ||
- `master` must never fail `make test` or `make test_cli` | ||
- `master` should not fail `make lint` | ||
- no `--force` onto `master` (except when reverting a broken commit, which should seldom happen) | ||
- the latest state of development is on `main` | ||
- `main` must never fail `make test` or `make test_cli` | ||
- `main` should not fail `make lint` | ||
- no `--force` onto `main` (except when reverting a broken commit, which should seldom happen) | ||
- create a development branch either on github.com/peggyjv/sommelier, or your fork (using `git remote add origin`) | ||
- before submitting a pull request, begin `git rebase` on top of `master` | ||
- before submitting a pull request, begin `git rebase` on top of `main` | ||
### Pull Merge Procedure | ||
- ensure pull branch is rebased on `master` | ||
- ensure pull branch is rebased on `main` | ||
- run `make test` and `make test_cli` to ensure that all tests pass | ||
- merge pull request | ||
### Release Procedure | ||
- Start on `master` | ||
- Start on `main` | ||
- Create the release candidate branch `rc/v*` (going forward known as **RC**) | ||
and ensure it's protected against pushing from anyone except the release | ||
manager/coordinator | ||
- **no PRs targeting this branch should be merged unless exceptional circumstances arise** | ||
- On the `RC` branch, prepare a new version section in the `CHANGELOG.md` and | ||
kick off a large round of simulation testing (e.g. 400 seeds for 2k blocks) | ||
- If errors are found during the simulation testing, commit the fixes to `master` | ||
- If errors are found during the simulation testing, commit the fixes to `main` | ||
and create a new `RC` branch (making sure to increment the `rcN`) | ||
- After simulation has successfully completed, create the release branch | ||
(`release/vX.XX.X`) from the `RC` branch | ||
- Merge the release branch to `master` to incorporate the `CHANGELOG.md` updates | ||
- Merge the release branch to `main` to incorporate the `CHANGELOG.md` updates | ||
- Delete the `RC` branches | ||
### Point Release Procedure | ||
|
@@ -213,13 +213,13 @@ releases will be based off of that release. | |
- start on `vX.XX.X` | ||
- checkout a new branch `rcN/vX.X.X` | ||
- cherry pick the desired changes from `master` | ||
- cherry pick the desired changes from `main` | ||
- these changes should be small and NON-BREAKING (both API and state machine) | ||
- add entries to CHANGELOG.md and remove corresponding pending log entries | ||
- checkout a new branch `release/vX.X.X` based off of the previous release | ||
- create a PR merging `rcN/vX.X.X` into `release/vX.X.X` | ||
- run tests and simulations (noted in [Release Procedure](#release-procedure)) | ||
- after tests and simulation have successfully completed, merge the `RC` branch into `release/vX.X.X` | ||
- Make sure to delete the `RC` branch | ||
- create a PR into `master` containing ONLY the CHANGELOG.md updates | ||
- create a PR into `main` containing ONLY the CHANGELOG.md updates | ||
- tag (use `git tag -a`) then push the tags (`git push --tags`) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters