Preview #441
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
| # This is a workflow for previewing packages. It can be used for testing before a release to the "production" systems. | |
| # It will automatically create developmental release builds and make them available for all pushes to `main`. There is | |
| # also an ability to manually trigger this workflow, with an additional option to publish the package to TestPyPI. | |
| --- | |
| name: Preview | |
| on: | |
| # Allow running this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| inputs: | |
| TestPyPI: | |
| description: "Publish to TestPyPI" | |
| type: boolean | |
| required: true | |
| default: false | |
| CompileWindows: | |
| description: "Create Windows binary" | |
| type: boolean | |
| required: true | |
| default: false | |
| push: | |
| branches: | |
| - main | |
| env: | |
| PYTHON_VERSION: "3.12" | |
| POETRY_VERSION: "1.8.3" | |
| jobs: | |
| publish_preview: | |
| name: Build and Publish for Preview | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| shell: bash | |
| outputs: | |
| next_ver: ${{ steps.dev_ver.outputs.next_ver }} | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| with: | |
| # `python-semantic-release` needs full history to properly determine the next release version | |
| fetch-depth: 0 | |
| - name: Install poetry | |
| run: pipx install poetry==${{ env.POETRY_VERSION }} | |
| - name: Configure poetry | |
| run: | | |
| poetry config virtualenvs.in-project true | |
| poetry config repositories.testpypi https://test.pypi.org/legacy/ | |
| - name: Set up Python | |
| uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| cache: 'poetry' | |
| - name: Install the project with poetry | |
| run: | | |
| poetry env use python${{ env.PYTHON_VERSION }} | |
| poetry check --lock | |
| poetry lock --no-update --no-cache | |
| poetry install --verbose --no-root --sync --with test,ci | |
| - name: Make developmental release version | |
| id: dev_ver | |
| # poetry version rules do not provide for developmental releases as specified in PEP440. | |
| # It can be pieced together with these commands. | |
| run: | | |
| curr_ver=$(poetry version --short) | |
| next_ver=$(poetry run semantic-release -v version --print) | |
| if [ "${curr_ver}" = "${next_ver}" ]; then | |
| next_ver=$(poetry run semantic-release -v version --print --patch) | |
| fi | |
| echo "next_ver=${next_ver}" >> "${GITHUB_OUTPUT}" | |
| poetry version "${next_ver}.dev${GITHUB_RUN_NUMBER}" | |
| - name: Run tox via poetry | |
| run: poetry run tox | |
| - name: Build wheel and source distribution | |
| run: poetry build -vvv | |
| - name: Upload build artifacts | |
| uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 | |
| with: | |
| name: dist | |
| path: ./dist/ | |
| if-no-files-found: error | |
| retention-days: 7 | |
| - name: Publish to TestPyPI | |
| if: inputs.TestPyPI | |
| run: poetry publish --repository testpypi --username __token__ --password ${{ secrets.TESTPYPI_API_TOKEN }} | |
| windows_build: | |
| name: Build Windows standalone binary | |
| if: inputs.CompileWindows | |
| needs: publish_preview | |
| runs-on: windows-latest | |
| steps: | |
| - name: Checkout the repo | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| # Nuitka needs the packaged form and not the editable install Poetry provides | |
| # Ref: https://github.com/Nuitka/Nuitka/issues/2965 | |
| - name: Download build artifacts | |
| uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 | |
| - name: Install poetry | |
| run: pipx install poetry==${{ env.POETRY_VERSION }} | |
| - name: Configure poetry | |
| run: poetry config virtualenvs.in-project true | |
| # TODO: Try setting up Python *before* installing/configuring Poetry | |
| - name: Set up Python | |
| uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| cache: 'poetry' | |
| - name: Install the project with poetry | |
| run: | | |
| poetry check --lock | |
| poetry lock --no-update --no-cache | |
| poetry install --verbose --no-root --sync --with compile | |
| poetry run python -m pip install --find-links dist phylum | |
| - name: Compile binary with Nuitka | |
| env: | |
| PREVIEW_VER: ${{ needs.publish_preview.outputs.next_ver }} | |
| run: | | |
| poetry run python -m nuitka ` | |
| --onefile ` | |
| --output-dir=build ` | |
| --output-filename="phylum-ci.exe" ` | |
| --include-package=phylum ` | |
| --include-package-data=phylum ` | |
| --include-distribution-metadata=phylum ` | |
| --onefile-tempdir-spec="{CACHE_DIR}/{PRODUCT}/{VERSION}" ` | |
| --product-name=phylum-ci ` | |
| --product-version=${env:PREVIEW_VER} ` | |
| --file-version=${env:GITHUB_RUN_NUMBER} ` | |
| --company-name="Phylum, Inc." ` | |
| --copyright="Copyright (C) 2022 Phylum, Inc." ` | |
| --file-description="Use Phylum to analyze dependencies in a CI environment" ` | |
| --windows-icon-from-ico="docs/img/favicon.ico" ` | |
| --warn-implicit-exceptions ` | |
| --warn-unusual-code ` | |
| --assume-yes-for-downloads ` | |
| --report=nuitka-compilation-report.xml ` | |
| --deployment ` | |
| src/phylum/ci/cli.py | |
| - name: Confirm operation of binary | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| PHYLUM_API_KEY: ${{ secrets.PHYLUM_TOKEN }} | |
| run: | | |
| ./build/phylum-ci.exe -h | |
| ./build/phylum-ci.exe -vvaf | |
| - name: Upload standalone binary | |
| uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 | |
| with: | |
| name: phylum-ci.exe | |
| path: ./build/phylum-ci.exe | |
| if-no-files-found: error | |
| retention-days: 7 | |
| - name: Upload compilation report | |
| if: always() | |
| uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 | |
| with: | |
| name: nuitka-compilation-report.xml | |
| path: ./nuitka-compilation-report.xml | |
| if-no-files-found: warn | |
| retention-days: 7 | |
| # Nuitka will create a crash report with a static name when there are failures | |
| - name: Upload crash report | |
| if: always() | |
| uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 | |
| with: | |
| name: nuitka-crash-report.xml | |
| path: ./nuitka-crash-report.xml | |
| if-no-files-found: ignore | |
| retention-days: 7 |