docs: add release yaml to improve release notes (#230) #522
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
| # This workflow will install Python dependencies, run tests and lint with a single version of Python | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: Library CI/CD | |
| permissions: | |
| id-token: write # This is required for requesting the JWT | |
| issues: write | |
| checks: read | |
| contents: read | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"] | |
| steps: | |
| - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event." | |
| - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!" | |
| - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}." | |
| - name: Check out repository code | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Set up Python | |
| uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b | |
| - name: Install dependencies | |
| run: | | |
| make dev | |
| - name: pre commit | |
| run: | | |
| make pre-commit | |
| - name: Lint with ruff | |
| run: | | |
| make lint | |
| - name: Complexity scan | |
| run: | | |
| make complex | |
| - name: Lint docs | |
| run: | | |
| npm install | |
| make lint-docs | |
| - run: echo "🖥️ The workflow is now ready to test your code on the runner." | |
| - name: Unit tests | |
| run: | | |
| make pipeline-tests | |
| - name: Codecov | |
| uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2 | |
| with: | |
| files: ./coverage.xml | |
| name: aws-lambda-env-parser-codecov | |
| fail_ci_if_error: false # optional (default = false) | |
| verbose: false # optional (default = false) | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| deploy_docs: | |
| name: deploy_docs | |
| runs-on: ubuntu-latest | |
| needs: [build] | |
| permissions: | |
| pages: write | |
| id-token: write | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| if: contains('refs/heads/main', github.ref) | |
| steps: | |
| - uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 | |
| - name: Check out repository code | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Set up Python | |
| uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 | |
| with: | |
| python-version: "3.14" | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b | |
| - name: Install dependencies | |
| run: | | |
| make dev | |
| - name: Build docs | |
| run: | | |
| uv run zensical build --clean | |
| - uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1 | |
| with: | |
| path: site | |
| - uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 | |
| id: deployment |