Skip to content

Commit

Permalink
Merge pull request #551 from opentensor/sam-add-companion-labels-check
Browse files Browse the repository at this point in the history
add CI check for companion labels, update deployment docs
  • Loading branch information
sam0x17 authored Jun 21, 2024
2 parents e8eae82 + 509af18 commit c097ff8
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 3 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/devnet-ready-labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: devnet-companion Label Check
on:
pull_request:
types: [opened, labeled, unlabeled, synchronize]
branches: [devnet-ready]
jobs:
check-labels:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: mheap/github-action-required-labels@v5
with:
mode: minimum
count: 1
labels: devnet-companion
17 changes: 17 additions & 0 deletions .github/workflows/testnet-ready-labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: testnet-companion Label Check
on:
pull_request:
types: [opened, labeled, unlabeled, synchronize]
branches: [testnet-ready]
jobs:
check-labels:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: mheap/github-action-required-labels@v5
with:
mode: minimum
count: 1
labels: testnet-companion
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
add appropriate labels to your PR as shown below. Three positive reviews are required.
4. Once the required passing reviews have been obtained, you are ready to request that your PR
be included in the next `devnet` deploy. To do this, you should open a companion PR merging
your branch into the `devnet-ready` branch. You must include a link to the parent PR in the
description and preface your PR title with "(Devnet Ready)" or the PR will be
closed/ignored.
a copy of your branch into the `devnet-ready` branch. You must include a link to the parent
PR in the description and preface your PR title with "(Devnet Ready)" or the PR will be
closed/ignored. Your companion PR should have the `devnet-companion` label.
5. A core team administrator will review your "(Devnet Ready)" PR, verifying that it logically
matches the changes introduced in the parent PR (there will sometimes be minor differences
due to merge conflicts) and will either request changes or approve the PR and merge it. Once
Expand Down Expand Up @@ -86,11 +86,13 @@
| `runtime` | PR contains substantive changes to runtime / pallet code | none |
| `breaking-change` | PR requires synchronized changes with bittensor | Triggers an automatic bot message so the relevant teams are made aware of the change well in advance |
| `migration` | PR contains one or more migrations | none |
| `devnet-companion` | Designates a devnet companion PR | Presence of `devnet-companion` label is checked |
| `devnet-ready` | PR's branch has been merged into the `devnet-ready` branch and will be included in the next `devnet` deploy | none |
| `on-devnet` | PR has been deployed to `devnet` | Removes `devnet-ready` |
| `devnet-pass` | PR has passed manual testing on `devnet` | `devnet-pass` or `devnet-skip` required |
| `devnet-skip` | Allows a critical hotfix PR to skip required testing on `devnet` | `devnet-pass` or `devnet-skip` required |
| `devnet-fail` | PR has failed manual testing on `devnet` and requires modification | none |
| `testnet-companion` | Designates a testnet companion PR | Presence of `testnet-companion` label is checked |
| `on-testnet` | PR has been deployed to `testnet` | none |
| `testnet-pass` | PR has passed manual testing on `testnet` | `testnet-pass` or `testnet-skip` required |
| `testnet-skip` | Allows a critical hotfix PR to skip required manual testing and SOP on `testnet` | `testnet-pass` or `testnet-skip` required |
Expand Down

0 comments on commit c097ff8

Please sign in to comment.