Skip to content

Commit

Permalink
Add backport GitHub action (#752)
Browse files Browse the repository at this point in the history
* Add backport GitHub action

* Add documentation

* Tweak docs title
  • Loading branch information
jonnydgreen authored Mar 9, 2022
1 parent 6e3ace1 commit 423ff0a
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/backport.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Backport
on:
pull_request:
types:
- closed
- labeled

jobs:
backport:
runs-on: ubuntu-latest
name: Backport
steps:
- name: Backport
uses: tibdex/backport@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
15 changes: 15 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Development

## Backporting

The Mercurius repository supports backporting PRs that also need to be applied to older versions.

### How do we do this?

As soon as one opens a PR against the default branch, and the change should be backported to `v8.x`, you should add the corresponding backport label. For example, if we need to backport something to `v8.x`, we add the following label:

- `backport v8.x`

And you are done! If there are no conflicts, the action will open a separate PR with the backport for review.

If the PR can't be automatically backported, the GitHub bot will comment the failure on the PR.
1 change: 1 addition & 0 deletions docsify/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,5 @@
* [altair-fastify-plugin](/docs/plugins#altair-fastify-plugin)
* [mercurius-apollo-registry](/docs/plugins#mercurius-apollo-registry)
* [mercurius-apollo-tracing](/docs/plugins#mercurius-apollo-tracing)
* [Development](/docs/development)
* [Faq](/docs/faq)

0 comments on commit 423ff0a

Please sign in to comment.