-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: updated actions and contribution docs (#601)
* Improved CONTRIBUTING Signed-off-by: Riccardo Montagnin <riccardo.montagnin@gmail.com> * Updated GitHub workflows Signed-off-by: Riccardo Montagnin <riccardo.montagnin@gmail.com> * Update STABLE_RELEASES.md Co-authored-by: Leonardo Bragagnolo <leo.braga95@gmail.com> * Removed lines Signed-off-by: Riccardo Montagnin <riccardo.montagnin@gmail.com> * Updated building modules link Signed-off-by: Riccardo Montagnin <riccardo.montagnin@gmail.com> Co-authored-by: Leonardo Bragagnolo <leo.braga95@gmail.com>
- Loading branch information
Showing
16 changed files
with
937 additions
and
27 deletions.
There are no files selected for viewing
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 |
---|---|---|
@@ -1,17 +1,43 @@ | ||
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺ | ||
v ✰ Thanks for creating a PR! ✰ | ||
v Before smashing the submit button please review the checkboxes. | ||
v If a checkbox is n/a - please still include it but + a little note why | ||
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > --> | ||
|
||
## Description | ||
<!-- Small description --> | ||
|
||
## Checklist | ||
- [ ] Targeted PR against correct branch. | ||
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work. | ||
- [ ] Wrote unit tests. | ||
- [ ] Wrote integration tests (simulation & CLI). | ||
- [ ] Updated the documentation. | ||
- [ ] Added an entry to the `CHANGELOG.md` file. | ||
- [ ] Re-reviewed `Files changed` in the Github PR explorer. | ||
|
||
Closes: #XXXX | ||
|
||
<!-- Add a description of the changes that this PR introduces and the files that | ||
are the most critical to review. --> | ||
|
||
--- | ||
|
||
### Author Checklist | ||
|
||
*All items are required. Please add a note to the item if the item is not applicable and | ||
please add links to any relevant follow up issues.* | ||
|
||
I have... | ||
|
||
- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title | ||
- [ ] added `!` to the type prefix if API or client breaking change | ||
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/desmos-labs/desmos/blob/master/CONTRIBUTING.md#pr-targeting)) | ||
- [ ] provided a link to the relevant issue or specification | ||
- [ ] followed the guidelines for [building modules](https://docs.cosmos.network/v0.44/building-modules/intro.html) | ||
- [ ] included the necessary unit and integration [tests](https://github.com/desmos-labs/desmos/blob/master/CONTRIBUTING.md#testing) | ||
- [ ] added a changelog entry to `CHANGELOG.md` | ||
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) | ||
- [ ] updated the relevant documentation or specification | ||
- [ ] reviewed "Files changed" and left comments if necessary | ||
- [ ] confirmed all CI checks have passed | ||
|
||
### Reviewers Checklist | ||
|
||
*All items are required. Please add a note if the item is not applicable and please add | ||
your handle next to the items reviewed if you only reviewed selected items.* | ||
|
||
I have... | ||
|
||
- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title | ||
- [ ] confirmed `!` in the type prefix if API or client breaking change | ||
- [ ] confirmed all author checklist items have been addressed | ||
- [ ] reviewed state machine logic | ||
- [ ] reviewed API design and naming | ||
- [ ] reviewed documentation is accurate | ||
- [ ] reviewed tests and test coverage | ||
- [ ] manually tested (if applicable) |
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 |
---|---|---|
@@ -0,0 +1,37 @@ | ||
## Description | ||
|
||
Closes: #XXXX | ||
|
||
<!-- Add a description of the changes that this PR introduces and the files that | ||
are the most critical to review. --> | ||
|
||
--- | ||
|
||
### Author Checklist | ||
|
||
*All items are required. Please add a note to the item if the item is not applicable and | ||
please add links to any relevant follow up issues.* | ||
|
||
I have... | ||
|
||
- [ ] included the correct `docs:` prefix in the PR title | ||
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/desmos-labs/desmos/blob/master/CONTRIBUTING.md#pr-targeting)) | ||
- [ ] provided a link to the relevant issue or specification | ||
- [ ] followed the [documentation writing guidelines](https://github.com/desmos-labs/desmos/blob/master/docs/DOC_WRITING_GUIDELINES.md) | ||
- [ ] reviewed "Files changed" and left comments if necessary | ||
- [ ] confirmed all CI checks have passed | ||
|
||
### Reviewers Checklist | ||
|
||
*All items are required. Please add a note if the item is not applicable and please add | ||
your handle next to the items reviewed if you only reviewed selected items.* | ||
|
||
I have... | ||
|
||
- [ ] confirmed the correct `docs:` prefix in the PR title | ||
- [ ] confirmed all author checklist items have been addressed | ||
- [ ] confirmed that this PR only changes documentation | ||
- [ ] reviewed content for consistency | ||
- [ ] reviewed content for thoroughness | ||
- [ ] reviewed content for spelling and grammar | ||
- [ ] tested instructions (if applicable) |
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 |
---|---|---|
@@ -0,0 +1,32 @@ | ||
## Description | ||
|
||
Closes: #XXXX | ||
|
||
<!-- Add a description of the changes that this PR introduces and the files that | ||
are the most critical to review. --> | ||
|
||
--- | ||
|
||
### Author Checklist | ||
|
||
*All items are required. Please add a note to the item if the item is not applicable and | ||
please add links to any relevant follow up issues.* | ||
|
||
I have... | ||
|
||
- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title | ||
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/desmos-labs/desmos/blob/master/CONTRIBUTING.md#pr-targeting)) | ||
- [ ] provided a link to the relevant issue or specification | ||
- [ ] reviewed "Files changed" and left comments if necessary | ||
- [ ] confirmed all CI checks have passed | ||
|
||
### Reviewers Checklist | ||
|
||
*All items are required. Please add a note if the item is not applicable and please add | ||
your handle next to the items reviewed if you only reviewed selected items.* | ||
|
||
I have... | ||
|
||
- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title | ||
- [ ] confirmed all author checklist items have been addressed | ||
- [ ] confirmed that this PR does not change production code |
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 |
---|---|---|
@@ -0,0 +1,17 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: github-actions | ||
directory: "/" | ||
schedule: | ||
interval: daily | ||
open-pull-requests-limit: 10 | ||
- package-ecosystem: gomod | ||
directory: "/" | ||
schedule: | ||
interval: daily | ||
open-pull-requests-limit: 10 | ||
reviewers: | ||
- riccardom | ||
labels: | ||
- automerge | ||
- dependencies |
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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
"x/profiles": | ||
- x/profiles/**/* | ||
"x/posts": | ||
- x/posts/**/* | ||
"x/subspaces": | ||
- x/subspaces/**/* | ||
"x/CLI": | ||
- client/**/* | ||
- x/*/client/**/* | ||
"kind/build": | ||
- Makefile | ||
- Dockerfile | ||
- docker-compose.yml | ||
- scripts/* | ||
"kind/ci": | ||
- .github/**/*.yml | ||
- buf.yaml | ||
- .mergify.yml | ||
- .golangci.yml | ||
"kind/ADR": | ||
- docs/architecture/**/* |
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 |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: Janitor | ||
# Janitor cleans up previous runs of various workflows | ||
# Cancels Sims and Tests | ||
on: | ||
pull_request: | ||
|
||
jobs: | ||
cancel: | ||
name: "Cancel Previous Runs" | ||
runs-on: ubuntu-latest | ||
timeout-minutes: 3 | ||
steps: | ||
- uses: styfle/cancel-workflow-action@0.9.1 | ||
with: | ||
workflow_id: 1130522,1865868 | ||
access_token: ${{ github.token }} |
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 |
---|---|---|
@@ -0,0 +1,11 @@ | ||
name: "Pull Request Labeler" | ||
on: | ||
- pull_request_target | ||
|
||
jobs: | ||
labeler: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/labeler@main | ||
with: | ||
repo-token: "${{ secrets.GITHUB_TOKEN }}" |
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 |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: "Lint PR" | ||
|
||
on: | ||
pull_request_target: | ||
types: | ||
- opened | ||
- edited | ||
- synchronize | ||
|
||
jobs: | ||
main: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: amannn/action-semantic-pull-request@v3.4.2 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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 |
---|---|---|
@@ -0,0 +1,41 @@ | ||
name: Release Sims | ||
# Release Sims workflow runs long-lived (multi-seed & large block size) simulations | ||
# This workflow only runs on a pull request when the branch contains rc** (rc1/vX.X.x) | ||
on: | ||
pull_request: | ||
branches: | ||
- "rc**" | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
if: "!contains(github.event.head_commit.message, 'skip-sims')" | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- run: | | ||
make build | ||
install-runsim: | ||
runs-on: ubuntu-latest | ||
needs: build | ||
steps: | ||
- name: install runsim | ||
run: | | ||
export GO111MODULE="on" && go get github.com/cosmos/tools/cmd/runsim@v1.0.0 | ||
- uses: actions/cache@v2.1.6 | ||
with: | ||
path: ~/go/bin | ||
key: ${{ runner.os }}-go-runsim-binary | ||
|
||
test-sim-multi-seed-long: | ||
runs-on: ubuntu-latest | ||
needs: [build, install-runsim] | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/cache@v2.1.6 | ||
with: | ||
path: ~/go/bin | ||
key: ${{ runner.os }}-go-runsim-binary | ||
- name: test-sim-multi-seed-long | ||
run: | | ||
make test-sim-multi-seed-long |
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
Oops, something went wrong.