Python Bindings for Formula Engine #2
Workflow file for this run
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
| name: Python CI | |
| on: | |
| merge_group: | |
| pull_request: | |
| push: | |
| # We need to explicitly include tags because otherwise when adding | |
| # `branches-ignore` it will only trigger on branches. | |
| tags: | |
| - '*' | |
| branches-ignore: | |
| # Ignore pushes to merge queues. | |
| # We only want to test the merge commit (`merge_group` event), the hashes | |
| # in the push were already tested by the PR checks | |
| - 'gh-readonly-queue/**' | |
| - 'dependabot/**' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| env: | |
| DEFAULT_PYTHON_VERSION: '3.11' | |
| jobs: | |
| test: | |
| runs-on: ${{ matrix.platform.runner }} | |
| strategy: | |
| matrix: | |
| platform: | |
| - runner: ubuntu-latest | |
| target: x86_64 | |
| - runner: ubuntu-latest | |
| target: x86 | |
| - runner: ubuntu-latest | |
| target: aarch64 | |
| - runner: ubuntu-latest | |
| target: armv7 | |
| - runner: macos-14 | |
| target: x86_64 | |
| - runner: macos-14 | |
| target: aarch64 | |
| - runner: macos-15 | |
| target: x86_64 | |
| - runner: macos-15 | |
| target: aarch64 | |
| nox-session: | |
| - "ci_checks_max" | |
| - "pytest_min" | |
| python: | |
| - "3.11" | |
| - "3.12" | |
| - "3.13" | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Run nox | |
| uses: frequenz-floss/[email protected] | |
| with: | |
| python-version: ${{ matrix.python }} | |
| nox-session: ${{ matrix.nox-session }} | |
| git-username: ${{ secrets.GIT_USER }} | |
| git-password: ${{ secrets.GIT_PASS }} | |
| build: | |
| name: Build distribution packages | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| needs: [test] | |
| runs-on: ${{ matrix.platform.runner }} | |
| strategy: | |
| matrix: | |
| platform: | |
| - runner: ubuntu-latest | |
| target: x86_64 | |
| - runner: ubuntu-latest | |
| target: x86 | |
| - runner: ubuntu-latest | |
| target: aarch64 | |
| - runner: ubuntu-latest | |
| target: armv7 | |
| - runner: macos-14 | |
| target: x86_64 | |
| - runner: macos-14 | |
| target: aarch64 | |
| - runner: macos-15 | |
| target: x86_64 | |
| - runner: macos-15 | |
| target: aarch64 | |
| python: | |
| - "3.11" | |
| - "3.12" | |
| - "3.13" | |
| steps: | |
| - name: Setup Git | |
| uses: frequenz-floss/[email protected] | |
| - name: Fetch sources | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.DEFAULT_PYTHON_VERSION }} | |
| cache: 'pip' | |
| - name: Install required Python packages | |
| run: | | |
| python -m pip install -U pip | |
| python -m pip install -U build | |
| pip freeze | |
| - name: Build the source and binary distribution | |
| run: python -m build | |
| - name: Upload distribution files | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: dist-packages-${{ matrix.platform.runner }}-${{ matrix.platform.target }}-${{ matrix.python }} | |
| path: dist/ | |
| if-no-files-found: error | |
| publish-docs: | |
| name: Publish documentation website to GitHub pages | |
| runs-on: ubuntu-20.04 | |
| needs: [build] | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Setup Git | |
| uses: frequenz-floss/[email protected] | |
| - name: Fetch sources | |
| uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.DEFAULT_PYTHON_VERSION }} | |
| cache: 'pip' | |
| - name: Install build dependencies | |
| run: | | |
| python -m pip install -U pip | |
| python -m pip install .[dev-mkdocs] | |
| pip freeze | |
| - name: Calculate and check version | |
| id: mike-version | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GITHUB_REPO: ${{ github.repository }} | |
| GIT_REF: ${{ github.ref }} | |
| GIT_SHA: ${{ github.sha }} | |
| run: | | |
| python -m frequenz.repo.config.cli.version.mike.info | |
| - name: Fetch the gh-pages branch | |
| if: steps.mike-version.outputs.version | |
| run: git fetch origin gh-pages --depth=1 | |
| - name: Build site | |
| if: steps.mike-version.outputs.version | |
| env: | |
| VERSION: ${{ steps.mike-version.outputs.version }} | |
| TITLE: ${{ steps.mike-version.outputs.title }} | |
| ALIASES: ${{ steps.mike-version.outputs.aliases }} | |
| # This is not ideal, we need to define all these variables here | |
| # because we need to calculate all the repository version information | |
| # to be able to show the correct versions in the documentation when | |
| # building it. | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GITHUB_REPO: ${{ github.repository }} | |
| GIT_REF: ${{ github.ref }} | |
| GIT_SHA: ${{ github.sha }} | |
| run: | | |
| mike deploy --update-aliases --title "$TITLE" "$VERSION" $ALIASES | |
| - name: Sort site versions | |
| if: steps.mike-version.outputs.version | |
| run: | | |
| git checkout gh-pages | |
| python -m frequenz.repo.config.cli.version.mike.sort versions.json | |
| git commit -a -m "Sort versions.json" | |
| - name: Publish site | |
| if: steps.mike-version.outputs.version | |
| run: | | |
| git push origin gh-pages | |
| create-github-release: | |
| name: Create GitHub release | |
| needs: ["publish-docs", "build"] | |
| # Create a release only on tags creation | |
| if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') | |
| permissions: | |
| # We need write permissions on contents to create GitHub releases and on | |
| # discussions to create the release announcement in the discussion forums | |
| contents: write | |
| discussions: write | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Download distribution files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: dist-packages-${{ matrix.platform.runner }}-${{ matrix.platform.target }}-${{ matrix.python }} | |
| path: dist | |
| - name: Download RELEASE_NOTES.md | |
| run: | | |
| set -ux | |
| gh api \ | |
| -X GET \ | |
| -f ref=$REF \ | |
| -H "Accept: application/vnd.github.raw" \ | |
| "/repos/$REPOSITORY/contents/RELEASE_NOTES.md" \ | |
| > RELEASE_NOTES.md | |
| env: | |
| REF: ${{ github.ref }} | |
| REPOSITORY: ${{ github.repository }} | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Create GitHub release | |
| run: | | |
| set -ux | |
| extra_opts= | |
| if echo "$REF_NAME" | grep -- -; then extra_opts=" --prerelease"; fi | |
| gh release create \ | |
| -R "$REPOSITORY" \ | |
| --notes-file RELEASE_NOTES.md \ | |
| --generate-notes \ | |
| $extra_opts \ | |
| $REF_NAME \ | |
| dist/* | |
| env: | |
| REF_NAME: ${{ github.ref_name }} | |
| REPOSITORY: ${{ github.repository }} | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| publish-to-pypi: | |
| name: Publish packages to PyPI | |
| needs: ["build"] | |
| runs-on: ubuntu-20.04 | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: Download distribution files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: dist-packages-${{ matrix.platform.runner }}-${{ matrix.platform.target }}-${{ matrix.python }} | |
| path: dist | |
| - name: Publish the Python distribution to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 |