ci(.github/action): rename the deploy-release action to move-released…

…-issues-and-create-sync-pr. Add a default value of the input pr-team-reviewers
dequelabs · Apr 15, 2024 · e976dd4 · e976dd4
1 parent 51d09dc
commit e976dd4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/.github/actions/deploy-release-v1/README.md → ...ed-issues-and-create-sync-pr-v1/README.md b/.github/actions/deploy-release-v1/README.md → ...ed-issues-and-create-sync-pr-v1/README.md
@@ -1,28 +1,28 @@
-# deploy-release-v1
+# move-released-issues-and-create-sync-pr-v1
 
 A GitHub Action to label all related issues with the package version and create a PR to sync branches
 
 ## Inputs
 
-| Name                | Required | Description                                  | Default |
-| ------------------- | -------- | -------------------------------------------- | ------- |
-| `token`             | Yes      | A GitHub token with the required permissions | NA      |
-| `project-number`    | No       | A project number of the project board        | 66      |
-| `head`              | No       | A head branch to sync from                   | main    |
-| `base`              | No       | A target branch for the created pull request | develop |
-| `pr-team-reviewers` | No       | Reviewers to tag on the created pull request | NA      |
+| Name                | Required | Description                                  | Default      |
+| ------------------- | -------- | -------------------------------------------- | ------------ |
+| `token`             | Yes      | A GitHub token with the required permissions | NA           |
+| `project-number`    | No       | A project number of the project board        | 66           |
+| `head`              | No       | A head branch to sync from                   | main         |
+| `base`              | No       | A target branch for the created pull request | develop      |
+| `pr-team-reviewers` | No       | Reviewers to tag on the created pull request | axe-api-team |
 
 ## Example usage
 
 ```yaml
 name: Deploy release
 
 jobs:
-  deploy-release:
+  move-released-issues-and-create-sync-pr:
     runs-on: ubuntu-latest
     timeout-minutes: 7
     steps:
-      - uses: dequelabs/axe-api-team-public/.github/actions/deploy-release-v1@main
+      - uses: dequelabs/axe-api-team-public/.github/actions/move-released-issues-and-create-sync-pr-v1@main
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           project-number: '66'

diff --git a/.github/actions/deploy-release-v1/action.yml → ...d-issues-and-create-sync-pr-v1/action.yml b/.github/actions/deploy-release-v1/action.yml → ...d-issues-and-create-sync-pr-v1/action.yml
@@ -1,4 +1,4 @@
-name: deploy-release-v1
+name: move-released-issues-and-create-sync-pr-v1
 description: Label all related issues with the package version and create a PR to sync branches
 
 inputs:
@@ -20,10 +20,12 @@ inputs:
   pr-team-reviewers:
     description: 'Reviewers to tag on the created pull request'
     required: false
+    default: axe-api-team
 
 runs:
   using: 'composite'
   steps:
+    # This step is required for the next steps
     - uses: actions/checkout@v4
       with:
         # Fetch all history