how-to do curated texts #38
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
| # Simple workflow for deploying static content to GitHub Pages | |
| # This script is adapted from the one that GitHub provides | |
| # as you apply the repo-settings for deploying Pages using GitHub Actions. | |
| # The adaptations include loading and using TEv2 tools | |
| name: Deploy static content to Pages | |
| on: | |
| # Runs on pushes and pull requests targeting the default branch | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| branches: ["main"] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: write # needed to commit the generated MRGs to the repo | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: false | |
| jobs: | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| # Setting up Node, as this is needed to install the TEv2 tools | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 20 | |
| # <TEv2 specific steps start here> | |
| # TEv2 Tool installation | |
| - name: Install terminology tools globally | |
| run: npm install -g @tno-terminology-design/trrt @tno-terminology-design/hrgt @tno-terminology-design/mrgt @tno-terminology-design/mrg-import | |
| # TEv2 Tool usage | |
| - name: Run terminology tools | |
| run: | | |
| cd docs | |
| mrg-import -c tev2-config.yaml | |
| mrgt -c tev2-config.yaml | |
| hrgt -f -c tev2-config.yaml | |
| trrt -f -c tev2-config.yaml | |
| # Commit generated MRGs to repo, so other projects can use (import) them | |
| - name: Commit MRGs to repository | |
| uses: stefanzweifel/git-auto-commit-action@v5 | |
| with: | |
| commit_message: Update MRGs | |
| file_pattern: 'docs/mrgs/mrg.mve*.yaml' | |
| # <TEv2 specific steps end here> | |
| # Setting up Python, as this is needed to build the MkDocs site | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.x' # Ensure this matches the Python version you need for MkDocs | |
| # MkDocs installation | |
| - name: Install MkDocs and extensions | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install mkdocs mkdocs-material pymdown-extensions pygments | |
| - name: Build the MkDocs site | |
| run: mkdocs build # Builds the static site from Markdown files | |
| working-directory: ${{github.workspace}} # Ensures mkdocs builds from the root directory | |
| # GitHub Pages setup | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 | |
| # Artifact upload for deployment | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: './site' # This should be the output directory of MkDocs | |
| # Deploy to GitHub Pages | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |