ci(deploy-docs): rename documentation label to deploy-docs label (#245)

* fix: rename documentation label to deploy-docs label Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp> * fix: image name Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp> * fix: image Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp> Signed-off-by: Shumpei Wakabayashi <shumpei.wakabayashi@tier4.jp>
autowarefoundation · Nov 16, 2022 · fbd3ffc · fbd3ffc
1 parent 272fae6
commit fbd3ffc
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 4 deletions.
diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
@@ -21,7 +21,7 @@ jobs:
   prevent-no-label-execution:
     uses: autowarefoundation/autoware-github-actions/.github/workflows/prevent-no-label-execution.yaml@v1
     with:
-      label: documentation
+      label: deploy-docs
 
   deploy-docs:
     needs: prevent-no-label-execution

diff --git a/...ributing/documentation-guidelines/images/deploy-docs-label-for-pull-request.png b/...ributing/documentation-guidelines/images/deploy-docs-label-for-pull-request.png
diff --git a/...buting/documentation-guidelines/images/documentation-label-for-pull-request.png b/...buting/documentation-guidelines/images/documentation-label-for-pull-request.png
diff --git a/docs/contributing/documentation-guidelines/index.md b/docs/contributing/documentation-guidelines/index.md
@@ -35,10 +35,10 @@ There are two ways to preview your modification on a documentation website.
 Follow the steps below.
 
 1. Create a pull request to the repository.
-2. Add the `documentation` label from the sidebar (See below figure).
+2. Add the `deploy-docs` label from the sidebar (See below figure).
 3. Wait for a couple of minutes, and the `github-actions` bot will notify the URL for the pull request's preview.
 
-![documentation-label](images/documentation-label-for-pull-request.png){ width="800" }
+![deploy-docs-label](images/deploy-docs-label-for-pull-request.png){ width="800" }
 
 #### 2. Running an MkDocs server in your local environment
 

diff --git a/docs/contributing/pull-request-guidelines/ci-checks.md b/docs/contributing/pull-request-guidelines/ci-checks.md
@@ -79,4 +79,4 @@ For the details about self-hosted runners, refer to [GitHub Docs](https://docs.g
 ## deploy-docs
 
 This workflow deploys the preview documentation site for the pull request.  
-You need to add the `documentation` label to run this workflow.
+You need to add the `deploy-docs` label to run this workflow.