Prepare v1.0.0 release docs, compact changelog workflow, consistent template scaffolds, agent guidance, and link-check stability #199
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
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| name: Render and Publish | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: '${{ github.workflow }}-${{ github.ref }}' | |
| cancel-in-progress: true | |
| jobs: | |
| lint: | |
| name: Lint with Prettier | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v5 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v5 | |
| with: | |
| node-version: '24' | |
| - name: Install dependencies | |
| run: npm install | |
| - name: Check for linting errors | |
| run: npm run check | |
| lint-python: | |
| name: Lint Python | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v5 | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v6 | |
| - name: Run ruff check | |
| run: uv run ruff check | |
| - name: Run ty check | |
| run: uv run ty check | |
| lint-r: | |
| name: Lint R | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v5 | |
| - name: Setup R | |
| uses: r-lib/actions/setup-r@v2 | |
| with: | |
| r-version: renv | |
| - name: Setup renv | |
| uses: r-lib/actions/setup-renv@v2 | |
| - name: Run lintr | |
| run: Rscript -e 'lintr::lint_dir(".")' | |
| build-optimize: | |
| name: Build, Optimize, and Upload Artifacts | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v5 | |
| - name: Overwrite _quarto.yml | |
| if: github.repository == 'maehr/open-research-data-template' | |
| run: | | |
| cp .github/_quarto.yml _quarto.yml | |
| - name: Set up Quarto | |
| uses: quarto-dev/quarto-actions/setup@v2 | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # with: | |
| # To install LaTeX to build PDF book outputs, uncomment below | |
| # tinytex: true | |
| # uncomment below and fill to pin a version | |
| # version: SPECIFIC-QUARTO-VERSION-HERE | |
| # add software dependencies here and any libraries | |
| # From https://github.com/astral-sh/setup-uv | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v6 | |
| # From https://github.com/r-lib/actions/tree/v2-branch/setup-r | |
| - name: Setup R | |
| uses: r-lib/actions/setup-r@v2 | |
| with: | |
| r-version: renv | |
| - uses: r-lib/actions/setup-renv@v2 | |
| # From https://github.com/julia-actions/setup-julia | |
| # - name: Setup Julia | |
| # uses: julia-actions/setup-julia@v1 | |
| # See more at https://github.com/quarto-dev/quarto-actions/blob/main/examples/example-03-dependencies.md | |
| - name: Render Quarto Project | |
| uses: quarto-dev/quarto-actions/render@v2 | |
| with: | |
| to: html | |
| - name: JamPack Optimization | |
| run: | | |
| npx @divriots/jampack ./_site | |
| - name: Upload Built Artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: built-site | |
| path: _site | |
| - name: Upload static files as artifact | |
| id: deployment | |
| uses: actions/upload-pages-artifact@v4 # or specific "vX.X.X" version tag for this action | |
| with: | |
| path: _site | |
| deploy: | |
| name: Deploy | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: [lint, lint-python, lint-r, build-optimize] | |
| if: github.event_name != 'pull_request' | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |