-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
185793e
commit 49c9b0f
Showing
1 changed file
with
55 additions
and
85 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,103 +1,73 @@ | ||
| name: Build documentation | ||
|
|
||
| on: | ||
| # If specified, the workflow will be triggered automatically once you push to the `main` branch. | ||
| # Replace `main` with your branch’s name | ||
| push: | ||
| branches: ["main"] | ||
| # Specify to run a workflow manually from the Actions tab on GitHub | ||
| workflow_dispatch: | ||
| push: | ||
| # To trigger the workflow once you push to the `main` branch | ||
| # Replace `main` with your branch’s name | ||
| branches: ["main"] | ||
| # Specify to run a workflow manually from the Actions tab on GitHub | ||
| workflow_dispatch: | ||
|
|
||
| # Gives the workflow permissions to clone the repo and create a page deployment | ||
| permissions: | ||
| id-token: write | ||
| pages: write | ||
| id-token: write | ||
| pages: write | ||
|
|
||
| env: | ||
| # Name of module and id separated by a slash | ||
| INSTANCE: Writerside/instance | ||
| # Replace HI with the ID of the instance in capital letters | ||
| ARTIFACT: webHelpINSTANCE2-all.zip | ||
| # Writerside docker image version | ||
| DOCKER_VERSION: 232.10275 | ||
| # Add the variable below to upload Algolia indexes | ||
| # Replace HI with the ID of the instance in capital letters | ||
| ALGOLIA_ARTIFACT: algolia-indexes-INSTANCE.zip | ||
| # Name of module and id separated by a slash | ||
| INSTANCE: Writerside/instance | ||
| # Replace XX with the ID of the instance in capital letters | ||
| ARTIFACT: webHelpINSTANCE2-all.zip | ||
| # Docker image version | ||
| DOCKER_VERSION: 232.10275 | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Build Writerside docs using Docker | ||
| uses: JetBrains/writerside-github-action@v4 | ||
| with: | ||
| instance: ${{ env.INSTANCE }} | ||
| artifact: ${{ env.ARTIFACT }} | ||
| docker-version: ${{ env.DOCKER_VERSION }} | ||
| - name: Build Writerside docs using Docker | ||
| uses: JetBrains/writerside-github-action@v4 | ||
| with: | ||
| instance: ${{ env.INSTANCE }} | ||
| artifact: ${{ env.ARTIFACT }} | ||
| docker-version: ${{ env.DOCKER_VERSION }} | ||
|
|
||
| - name: Upload documentation | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: docs | ||
| path: | | ||
| artifacts/${{ env.ARTIFACT }} | ||
| artifacts/report.json | ||
| retention-days: 7 | ||
| - name: Upload artifact | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: docs | ||
| path: | | ||
| artifacts/${{ env.ARTIFACT }} | ||
| retention-days: 7 | ||
|
|
||
| # Add the step below to upload Algolia indexes | ||
| - name: Upload algolia-indexes | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: algolia-indexes | ||
| path: artifacts/${{ env.ALGOLIA_ARTIFACT }} | ||
| retention-days: 7 | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| # Requires build job results | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
|
|
||
| # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors | ||
| # test: | ||
| # # Requires build job results | ||
| # needs: build | ||
| # runs-on: ubuntu-latest | ||
| # | ||
| # steps: | ||
| # - name: Download artifacts | ||
| # uses: actions/download-artifact@v1 | ||
| # with: | ||
| # name: docs | ||
| # path: artifacts | ||
| # | ||
| # - name: Test documentation | ||
| # uses: JetBrains/writerside-checker-action@v1 | ||
| # with: | ||
| # instance: ${{ env.INSTANCE }} | ||
| steps: | ||
| - name: Download artifact | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: docs | ||
|
|
||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| # Requires the build job results | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Download artifact | ||
| uses: actions/download-artifact@v3 | ||
| with: | ||
| name: docs | ||
| - name: Unzip artifact | ||
| run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir | ||
|
|
||
| - name: Unzip artifact | ||
| run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v2 | ||
|
|
||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v2 | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v1 | ||
| with: | ||
| path: dir | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v1 | ||
| with: | ||
| path: dir | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v1 | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v1 |