feat(deploy-docs): add new input variable to select mkdocs-requiremen…

…ts (#164) * feat(deploy-docs): add new input variable to select mkdocs-requirements Signed-off-by: Takayuki AKAMINE <[email protected]> * chore(deploy-docs): updated README.md Signed-off-by: Takayuki AKAMINE <[email protected]> * Update deploy-docs/README.md Co-authored-by: Kenji Miyake <[email protected]> * ci(pre-commit): autofix * Update deploy-docs/action.yaml Co-authored-by: Kenji Miyake <[email protected]> * Update deploy-docs/action.yaml Co-authored-by: Kenji Miyake <[email protected]> Co-authored-by: Kenji Miyake <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
autowarefoundation · Jun 9, 2022 · ba750d8 · ba750d8
1 parent 5926b5a
commit ba750d8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/deploy-docs/README.md b/deploy-docs/README.md
@@ -25,10 +25,11 @@ jobs:
 
 ## Inputs
 
-| Name   | Required | Description                           |
-| ------ | -------- | ------------------------------------- |
-| token  | true     | The token for push to `gh-pages`.     |
-| latest | true     | Whether to create the `latest` alias. |
+| Name                    | Required | Description                           |
+| ----------------------- | -------- | ------------------------------------- |
+| token                   | true     | The token for push to `gh-pages`.     |
+| latest                  | true     | Whether to create the `latest` alias. |
+| mkdocs-requirements-txt | false    | `requirements.txt` for MkDocs         |
 
 ## Outputs
 

diff --git a/deploy-docs/action.yaml b/deploy-docs/action.yaml
@@ -8,6 +8,10 @@ inputs:
   latest:
     description: ""
     required: false
+  mkdocs-requirements-txt:
+    description: ""
+    required: false
+    default: ${GITHUB_ACTION_PATH}/mkdocs-requirements.txt
 
 runs:
   using: composite
@@ -20,7 +24,7 @@ runs:
     - name: Install MkDocs
       run: |
         pip3 install -U wheel
-        pip3 install -r ${GITHUB_ACTION_PATH}/mkdocs-requirements.txt
+        pip3 install -r ${{ inputs.mkdocs-requirements-txt }}
       shell: bash
 
     # TODO: Remove after v1.2.0 or v2.0.0 is released