⬆️ updated to Meteor.js version 3.5.1 incl. package dependencies #43
This file contains hidden or 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
| # .github/workflows/update-apidocs.yml | |
| name: Generate and Deploy API Docs | |
| # Controls when the action will run. | |
| # This workflow runs on every push to the 'main' branch. | |
| on: | |
| push: | |
| branches: | |
| - master # Change this to your default branch (e.g., master) | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| build-and-deploy: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| - name: Free disk space | |
| run: curl -fsSL https://raw.githubusercontent.com/kou/arrow/e49d8ae15583ceff03237571569099a6ad62be32/ci/scripts/util_free_space.sh | bash | |
| # 1. Checks out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - name: Checkout repository | |
| uses: actions/checkout@v5 | |
| # 2. Sets up Node.js in the runner | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: '20' # Specify the Node.js version you use | |
| # 3. Installs the apidoc CLI tool globally | |
| - name: Install apidoc | |
| run: npm install -g apidoc | |
| # 4. Runs the apidoc command to generate documentation | |
| # -i: input directory (where your documented source code is) | |
| # -o: output directory (where the docs will be generated) | |
| - name: Generate API Docs | |
| run: mkdir ./apidoc && apidoc -i server/ -o ./apidoc/ | |
| # 5. Deploys the generated documentation to the gh-pages branch | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| # This token is provided by Actions, you do not need to create your own secret | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # The directory where your generated documentation is located | |
| publish_dir: ./apidoc |