Add documentation section to README.md #1028
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
| on: | |
| # Triggers the workflow on push and pull request events for specific branches | |
| push: | |
| branches: | |
| - main | |
| - develop | |
| - 'release/**' | |
| - 'feature/**' | |
| - 'bugfix/**' | |
| pull_request: | |
| branches: | |
| - main | |
| - develop | |
| - 'release/**' | |
| - 'feature/**' | |
| - 'bugfix/**' | |
| # required to upload to GitHub pages | |
| permissions: | |
| contents: write | |
| jobs: | |
| run: | |
| concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession. | |
| runs-on: ubuntu-latest | |
| steps: | |
| - run: echo "Job was automatically triggered by a ${{ github.event_name }} event for branch ${{ github.ref }}" | |
| - name: Check out repository code for push | |
| if: github.event_name == 'push' # only if this is a push to a branch | |
| uses: actions/checkout@v4 | |
| - name: Check out repository code for pull_request | |
| if: github.event_name == 'pull_request' # only if this is a pull_request to a branch | |
| uses: actions/checkout@v4 | |
| with: | |
| # https://github.com/marketplace/actions/add-commit#working-with-prs | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| ref: ${{ github.event.pull_request.head.ref }} | |
| - name: Install java, xmllint and xsltproc | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install default-jre libxml2-utils xsltproc | |
| - name: Validate structure and lint XSD and XML files | |
| run: ./.github/scripts/validate-and-lint.sh | |
| - name: Validate OJP XML examples | |
| run: ./.github/scripts/validate-examples.sh | |
| - name: Generate documentation tables | |
| run: ./docs/generate-tables.sh | |
| - name: Get branch name | |
| id: get-branch-name | |
| # Done as an extra step because ${{ github.ref }} has "refs/heads/" prepended and there is no operation on GitHub strings possible | |
| # https://github.com/orgs/community/discussions/26625 | |
| if: github.event_name == 'push' # only if this is a push to a branch | |
| # cut -d/ -f3,4 splits the ${{ github.ref }} using "/" and returns 3rd and optional 4th position | |
| run: | | |
| BRANCH_NAME=$(echo ${{ github.ref }} | cut -d/ -f3,4) | |
| echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_OUTPUT | |
| - name: Upload generated documentation tables | |
| if: github.event_name == 'push' # only if this is a push to a branch | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| branch: gh-pages | |
| folder: './docs/generated' | |
| target-folder: "${{steps.get-branch-name.outputs.BRANCH_NAME}}" | |
| - name: Remove generated documentation tables | |
| run: rm -rf ./docs/generated/documentation-tables | |
| - name: Commit changes for push | |
| if: github.event_name == 'push' # only if this is a push to a branch | |
| uses: EndBug/add-and-commit@v9 # https://github.com/marketplace/actions/add-commit | |
| with: | |
| default_author: github_actions | |
| message: 'fixup! Fixed linting errors' | |
| push: --set-upstream origin "${{steps.get-branch-name.outputs.BRANCH_NAME}}" | |
| - name: Commit changes for pull_request | |
| if: github.event_name == 'pull_request' # only if this is a pull_request to a branch | |
| uses: EndBug/add-and-commit@v9 # https://github.com/marketplace/actions/add-commit | |
| with: | |
| default_author: github_actions | |
| message: 'fixup! Fixed linting errors' |