@@ -3,41 +3,33 @@ description: Builds and/or Deploys MkDocs Material to GitHub Pages, or a Directo
33
44inputs :
55 mkdocs-version :
6- type : string
76 required : false
87 default : " latest"
98 description : " MkDocs version to use"
109 requirements :
11- type : string
1210 required : false
1311 default : " ./docs/requirements.txt"
1412 description : " Path to the requirements.txt file"
1513 config-file :
16- type : string
1714 required : false
1815 default : " mkdocs.yml"
1916 description : " Path to the mkdocs.yml file"
2017 publish-to-pages :
21- type : boolean
2218 required : false
23- default : true
19+ default : " true"
2420 description : " Whether to publish to GitHub Pages"
2521 checkout-current-repo :
26- type : boolean
2722 required : false
28- default : true
23+ default : " true"
2924 description : " Whether to perform repository checkout"
3025 pre-build-script :
31- type : string
3226 required : false
3327 description : " Path to the pre-build script"
3428 pre-build-shell :
35- type : string
3629 required : false
3730 default : " bash"
3831 description : " Shell to use for running the pre-build script"
3932 output-directory :
40- type : string
4133 required : false
4234 default : " ./site"
4335 description : " Custom output directory for the MkDocs build"
@@ -46,13 +38,13 @@ runs:
4638 using : " composite"
4739 steps :
4840 - name : Checkout Repository
49- if : ${{ inputs.checkout-current-repo }}
41+ if : ${{ inputs.checkout-current-repo == 'true' }}
5042 uses : actions/checkout@v4
5143 with :
5244 submodules : " recursive"
5345
5446 - name : Setup Pages
55- if : ${{ inputs.publish-to-pages }}
47+ if : ${{ inputs.publish-to-pages == 'true' }}
5648 id : pages
5749 uses : actions/configure-pages@v4
5850
@@ -82,14 +74,14 @@ runs:
8274 run : mkdocs build --config-file "${{ inputs.config-file }}" --site-dir "${{ inputs.output-directory }}"
8375
8476 - name : Upload pages artifact
85- if : ${{ inputs.publish-to-pages }}
77+ if : ${{ inputs.publish-to-pages == 'true' }}
8678 uses : actions/upload-pages-artifact@v3
8779 with :
8880 name : " github-pages"
8981 path : " ${{ inputs.output-directory }}"
9082
9183 - name : Deploy to GitHub Pages
92- if : ${{ inputs.publish-to-pages }}
84+ if : ${{ inputs.publish-to-pages == 'true' }}
9385 id : deployment
9486 uses : actions/deploy-pages@v4
9587 with :
0 commit comments