Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Nov 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/contributing/documentation-guidelines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/pull-request-guidelines/ci-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.