Update: description and examples #16
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Nightly documentation | |
| on: | |
| push: | |
| branches: | |
| - '**' | |
| tags-ignore: | |
| - '**' | |
| jobs: | |
| nightly-docs: | |
| if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Configure workflow | |
| id: configuration | |
| run: | | |
| BRANCH_NAME="${GITHUB_REF#refs/*/}" | |
| echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_OUTPUT | |
| echo "DOCS_OUTPUT_DIR=${GITHUB_WORKSPACE}/skript-docs/docs/nightly/${BRANCH_NAME}" >> $GITHUB_OUTPUT | |
| echo "DOCS_REPO_DIR=${GITHUB_WORKSPACE}/skript-docs" >> $GITHUB_OUTPUT | |
| echo "SKRIPT_REPO_DIR=${GITHUB_WORKSPACE}/skript" >> $GITHUB_OUTPUT | |
| - name: Checkout Skript | |
| uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| path: skript | |
| - name: Setup documentation environment | |
| uses: ./skript/.github/workflows/docs/setup-docs | |
| with: | |
| docs_deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }} | |
| docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }} | |
| - name: Generate documentation | |
| uses: ./skript/.github/workflows/docs/generate-docs | |
| with: | |
| docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }} | |
| docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }} | |
| skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }} | |
| - name: Push nightly documentation | |
| uses: ./skript/.github/workflows/docs/push-docs | |
| with: | |
| docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }} | |
| docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }} | |
| git_name: Nightly Docs Bot | |
| git_email: [email protected] | |
| git_commit_message: "Update ${{ steps.configuration.outputs.BRANCH_NAME }} branch nightly docs to ${{ github.repository }}@${{ github.sha }}" |