Skip to content

Commit

Permalink
workflows: update branch target to main
Browse files Browse the repository at this point in the history
  • Loading branch information
fedekunze committed Jan 7, 2021
1 parent 7fc2e32 commit 48aa113
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 65 deletions.
38 changes: 0 additions & 38 deletions .github/workflows/build-latest-sdk.yml

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: Lint
# Lint runs golangci-lint over the entire sommelier repository
# This workflow is run on every pull request and push to master
# This workflow is run on every pull request and push to main
# The `golangci` job will pass without running if no *.{go, mod, sum} files have been modified.
on:
pull_request:
push:
branches:
- master
- main
jobs:
golangci:
name: golangci-lint
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-sims.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- uses: rokroskar/workflow-run-cleanup-action@master
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/master'"
if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main'"

build:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sims.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
- uses: rokroskar/workflow-run-cleanup-action@master
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/master'"
if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main'"

build:
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
- uses: rokroskar/workflow-run-cleanup-action@master
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/master'"
if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main'"

test-coverage-upload:
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions .mergify.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
pull_request_rules:
- name: automerge to master with label automerge and branch protection passing
- name: automerge to main with label automerge and branch protection passing
conditions:
- "#approved-reviews-by>1"
- base=master
- base=main
- label=automerge
actions:
merge:
Expand Down
32 changes: 16 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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`.

Expand Down Expand Up @@ -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
Expand All @@ -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`)
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -233,11 +233,11 @@ proto-lint:
@$(DOCKER_BUF) check lint --error-format=json

proto-check-breaking:
@$(DOCKER_BUF) check breaking --against-input $(HTTPS_GIT)#branch=master
@$(DOCKER_BUF) check breaking --against-input $(HTTPS_GIT)#branch=main

TM_URL = https://raw.githubusercontent.com/tendermint/tendermint/v0.34.0/proto/tendermint
GOGO_PROTO_URL = https://raw.githubusercontent.com/regen-network/protobuf/cosmos
COSMOS_PROTO_URL = https://raw.githubusercontent.com/regen-network/cosmos-proto/master
COSMOS_PROTO_URL = https://raw.githubusercontent.com/regen-network/cosmos-proto/main
COSMOS_SDK_PROTO_URL = https://raw.githubusercontent.com/cosmos/cosmos-sdk/v0.40.0-rc6/proto/cosmos/base

TM_CRYPTO_TYPES = third_party/proto/tendermint/crypto
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Sommelier 3.0 is a test version of the Stargate binaries.

[![codecov](https://codecov.io/gh/peggyjv/sommelier/branch/master/graph/badge.svg)](https://codecov.io/gh/peggyjv/sommelier)
[![codecov](https://codecov.io/gh/peggyjv/sommelier/branch/main/graph/badge.svg)](https://codecov.io/gh/peggyjv/sommelier)
[![Go Report Card](https://goreportcard.com/badge/github.com/peggyjv/sommelier)](https://goreportcard.com/report/github.com/peggyjv/sommelier)
[![license](https://img.shields.io/github/license/peggyjv/sommelier.svg)](https://github.com/peggyjv/sommelier/blob/master/LICENSE)
[![license](https://img.shields.io/github/license/peggyjv/sommelier.svg)](https://github.com/peggyjv/sommelier/blob/main/LICENSE)
[![LoC](https://tokei.rs/b1/github/peggyjv/sommelier)](https://github.com/peggyjv/sommelier)
[![GolangCI](https://golangci.com/badges/github.com/peggyjv/sommelier.svg)](https://golangci.com/r/github.com/peggyjv/sommelier)

Expand Down

0 comments on commit 48aa113

Please sign in to comment.