|
1 | | -# For issues that should be fixed by the docs team, |
2 | | -# this workflow copies the issue to the docs-content repo |
3 | | -# when the `documentation` label is added |
4 | | -# (we do not transfer so that the issue does not disappear for the contributor) |
| 1 | +# When the `documentation` label is added for documentation issues, |
| 2 | +# this workflow copies the issue to the API team repo which can then |
| 3 | +# be transferred to the feature team that owns the problem endpoint |
| 4 | +# so they can resolve the documentation problem |
| 5 | +# (we do not transfer the original issue so that the issue does not disappear for the contributor) |
5 | 6 |
|
6 | | -name: Copy to docs-content |
| 7 | +name: Copy documentation issue |
7 | 8 |
|
8 | 9 | on: |
9 | 10 | issues: |
|
12 | 13 |
|
13 | 14 | jobs: |
14 | 15 | copy-issue: |
15 | | - name: Copy issue |
| 16 | + name: Copy documentation issue |
16 | 17 | runs-on: ubuntu-latest |
17 | 18 | if: github.event.label.name == 'documentation' |
18 | 19 | steps: |
|
32 | 33 | } |
33 | 34 | return priority |
34 | 35 |
|
35 | | - - name: Create an issue in the docs-content repo |
| 36 | + - name: Create an issue in the api-platform repo |
36 | 37 | run: | |
37 | | - new_issue_url="$(gh issue create --title "$ISSUE_TITLE" --body "$ISSUE_BODY" --repo github/docs-content --label "REST,OpenAPI")" |
| 38 | + new_issue_url="$(gh issue create --title "$ISSUE_TITLE" --body "$ISSUE_BODY" --repo github/api-platform --label "REST,OpenAPI")" |
38 | 39 | echo 'NEW_ISSUE='$new_issue_url >> $GITHUB_ENV |
39 | 40 | env: |
40 | 41 | GITHUB_TOKEN: ${{secrets.ISSUE_TRANSFER_TOKEN}} |
|
43 | 44 |
|
44 | 45 | - name: Comment on the new issue |
45 | 46 | run: | |
46 | | - gh issue comment $NEW_ISSUE --body "This issue was originally opened in the rest-api-description repo as $OLD_ISSUE with priority $PRIORITY on a scale of P1 (high) to P4 (low). |
| 47 | + gh issue comment $NEW_ISSUE --body "This issue was originally opened in the rest-api-description repo as $OLD_ISSUE with priority $PRIORITY on a scale of P1 (high) to P4 (low). Please transfer it to the appropriate feature team. |
47 | 48 | :exclamation: When you close this issue, also comment on and close the original issue. |
48 | 49 | :question: Was this issue something that could have been caught by a linter? If so, suggest a new rule in [#api-platform](https://github.slack.com/archives/C1042T6MS)." |
49 | 50 | env: |
|
0 commit comments