From f9154e8297a1da02d559dc41bef62cc950c10666 Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Thu, 18 Jan 2024 15:44:11 -0500 Subject: [PATCH] Add release workflow (#961) ## Summary This PR adds a release workflow powered by `cargo-dist`. It's similar to the version that's PR'd in Ruff (https://github.com/astral-sh/ruff/pull/9559), with the exception that it doesn't include the Docker build or the "update dependents" step for pre-commit. --- .github/workflows/build-binaries.yml | 478 ++++++++++++++++++++++++++ .github/workflows/{ci.yaml => ci.yml} | 0 .github/workflows/publish-pypi.yml | 33 ++ .github/workflows/release.yml | 220 ++++++++++++ Cargo.toml | 42 ++- crates/distribution-types/Cargo.toml | 2 +- crates/pep440-rs/Cargo.toml | 2 +- crates/puffin-distribution/Cargo.toml | 2 +- crates/puffin-installer/Cargo.toml | 2 +- crates/puffin-resolver/Cargo.toml | 2 +- pyproject.toml | 20 ++ python/puffin/__init__.py | 0 python/puffin/__main__.py | 39 +++ requirements.in | 1 + 14 files changed, 834 insertions(+), 9 deletions(-) create mode 100644 .github/workflows/build-binaries.yml rename .github/workflows/{ci.yaml => ci.yml} (100%) create mode 100644 .github/workflows/publish-pypi.yml create mode 100644 .github/workflows/release.yml create mode 100644 pyproject.toml create mode 100644 python/puffin/__init__.py create mode 100644 python/puffin/__main__.py create mode 100644 requirements.in diff --git a/.github/workflows/build-binaries.yml b/.github/workflows/build-binaries.yml new file mode 100644 index 000000000000..776803bec2b5 --- /dev/null +++ b/.github/workflows/build-binaries.yml @@ -0,0 +1,478 @@ +# Build Puffin on all platforms. +# +# Generates both wheels (for PyPI) and archived binaries (for GitHub releases). +# +# Assumed to run as a subworkflow of .github/workflows/release.yml; specifically, as a local +# artifacts job within `cargo-dist`. +name: "Build binaries" + +on: + workflow_call: + inputs: + plan: + required: true + type: string + pull_request: + paths: + # When we change pyproject.toml, we want to ensure that the maturin builds still work. + - pyproject.toml + # And when we change this workflow itself... + - .github/workflows/*.yml + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +env: + PACKAGE_NAME: puffin_alpha + MODULE_NAME: puffin + PYTHON_VERSION: "3.11" + CARGO_INCREMENTAL: 0 + CARGO_NET_RETRY: 10 + CARGO_TERM_COLOR: always + RUSTUP_MAX_RETRIES: 10 + +jobs: + sdist: + # TODO(charlie): Enable source distribution builds. + if: false + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + - name: "Prep README.md" + run: echo "# Puffin" > README.md + - name: "Build sdist" + uses: PyO3/maturin-action@v1 + with: + command: sdist + args: --out dist + - name: "Test sdist" + run: | + pip install dist/${{ env.PACKAGE_NAME }}-*.tar.gz --force-reinstall + ${{ env.MODULE_NAME }} --help + python -m ${{ env.MODULE_NAME }} --help + - name: "Upload sdist" + uses: actions/upload-artifact@v3 + with: + name: wheels + path: dist + + macos-x86_64: + runs-on: macos-latest + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + architecture: x64 + - name: "Prep README.md" + run: echo "# Puffin" > README.md + - name: "Build wheels - x86_64" + uses: PyO3/maturin-action@v1 + with: + target: x86_64 + args: --release --locked --out dist + - name: "Test wheel - x86_64" + run: | + pip install dist/${{ env.PACKAGE_NAME }}-*.whl --force-reinstall + ${{ env.MODULE_NAME }} --help + python -m ${{ env.MODULE_NAME }} --help + - name: "Upload wheels" + uses: actions/upload-artifact@v3 + with: + name: wheels + path: dist + - name: "Archive binary" + run: | + TARGET=x86_64-apple-darwin + ARCHIVE_NAME=puffin-$TARGET + ARCHIVE_FILE=$ARCHIVE_NAME.tar.gz + + mkdir -p $ARCHIVE_NAME + cp target/$TARGET/release/puffin $ARCHIVE_NAME/puffin + tar czvf $ARCHIVE_FILE $ARCHIVE_NAME + shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 + - name: "Upload binary" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + *.tar.gz + *.sha256 + + macos-universal: + runs-on: macos-latest + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + architecture: x64 + - name: "Prep README.md" + run: echo "# Puffin" > README.md + - name: "Build wheels - universal2" + uses: PyO3/maturin-action@v1 + with: + args: --release --locked --target universal2-apple-darwin --out dist + - name: "Test wheel - universal2" + run: | + pip install dist/${{ env.PACKAGE_NAME }}-*universal2.whl --force-reinstall + ${{ env.MODULE_NAME }} --help + python -m ${{ env.MODULE_NAME }} --help + - name: "Upload wheels" + uses: actions/upload-artifact@v3 + with: + name: wheels + path: dist + - name: "Archive binary" + run: | + TARGET=aarch64-apple-darwin + ARCHIVE_NAME=puffin-$TARGET + ARCHIVE_FILE=$ARCHIVE_NAME.tar.gz + + mkdir -p $ARCHIVE_NAME + cp target/$TARGET/release/puffin $ARCHIVE_NAME/puffin + tar czvf $ARCHIVE_FILE $ARCHIVE_NAME + shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 + - name: "Upload binary" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + *.tar.gz + *.sha256 + + windows: + # TODO(charlie): Enable Windows builds. + if: false + runs-on: windows-latest + strategy: + matrix: + platform: + - target: x86_64-pc-windows-msvc + arch: x64 + - target: i686-pc-windows-msvc + arch: x86 + - target: aarch64-pc-windows-msvc + arch: x64 + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + architecture: ${{ matrix.platform.arch }} + - name: "Prep README.md" + run: echo "# Puffin" > README.md + - name: "Build wheels" + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.platform.target }} + args: --release --locked --out dist + - name: "Test wheel" + if: ${{ !startsWith(matrix.platform.target, 'aarch64') }} + shell: bash + run: | + python -m pip install dist/${{ env.PACKAGE_NAME }}-*.whl --force-reinstall + ${{ env.MODULE_NAME }} --help + python -m ${{ env.MODULE_NAME }} --help + - name: "Upload wheels" + uses: actions/upload-artifact@v3 + with: + name: wheels + path: dist + - name: "Archive binary" + shell: bash + run: | + ARCHIVE_FILE=puffin-${{ matrix.platform.target }}.zip + 7z a $ARCHIVE_FILE ./target/${{ matrix.platform.target }}/release/puffin.exe + sha256sum $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 + - name: "Upload binary" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + *.zip + *.sha256 + + linux: + runs-on: ubuntu-latest + strategy: + matrix: + target: + - x86_64-unknown-linux-gnu + - i686-unknown-linux-gnu + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + architecture: x64 + - name: "Prep README.md" + run: echo "# Puffin" > README.md + - name: "Build wheels" + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.target }} + manylinux: auto + args: --release --locked --out dist + # See: https://github.com/sfackler/rust-openssl/issues/2036#issuecomment-1724324145 + before-script-linux: | + # If we're running on rhel centos, install needed packages. + if command -v yum &> /dev/null; then + yum update -y && yum install -y perl-core openssl openssl-devel pkgconfig libatomic + + # If we're running on i686 we need to symlink libatomic + # in order to build openssl with -latomic flag. + if [[ ! -d "/usr/lib64" ]]; then + ln -s /usr/lib/libatomic.so.1 /usr/lib/libatomic.so + fi + else + # If we're running on debian-based system. + apt update -y && apt-get install -y libssl-dev openssl pkg-config + fi + - name: "Test wheel" + if: ${{ startsWith(matrix.target, 'x86_64') }} + run: | + pip install dist/${{ env.PACKAGE_NAME }}-*.whl --force-reinstall + ${{ env.MODULE_NAME }} --help + python -m ${{ env.MODULE_NAME }} --help + - name: "Upload wheels" + uses: actions/upload-artifact@v3 + with: + name: wheels + path: dist + - name: "Archive binary" + shell: bash + run: | + set -euo pipefail + + TARGET=${{ matrix.target }} + ARCHIVE_NAME=puffin-$TARGET + ARCHIVE_FILE=$ARCHIVE_NAME.tar.gz + + mkdir -p $ARCHIVE_NAME + cp target/$TARGET/release/puffin $ARCHIVE_NAME/puffin + tar czvf $ARCHIVE_FILE $ARCHIVE_NAME + shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 + - name: "Upload binary" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + *.tar.gz + *.sha256 + + linux-cross: + # TODO(charlie): Enable cross-compilation. + if: false + runs-on: ubuntu-latest + strategy: + matrix: + platform: + - target: aarch64-unknown-linux-gnu + arch: aarch64 + # see https://github.com/astral-sh/puffin/issues/3791 + # and https://github.com/gnzlbg/jemallocator/issues/170#issuecomment-1503228963 + maturin_docker_options: -e JEMALLOC_SYS_WITH_LG_PAGE=16 + - target: armv7-unknown-linux-gnueabihf + arch: armv7 + - target: s390x-unknown-linux-gnu + arch: s390x + - target: powerpc64le-unknown-linux-gnu + arch: ppc64le + - target: powerpc64-unknown-linux-gnu + arch: ppc64 + + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + - name: "Prep README.md" + run: echo "# Puffin" > README.md + - name: "Build wheels" + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.platform.target }} + manylinux: auto + docker-options: ${{ matrix.platform.maturin_docker_options }} + args: --release --locked --out dist + - uses: uraimo/run-on-arch-action@v2 + if: matrix.platform.arch != 'ppc64' + name: Test wheel + with: + arch: ${{ matrix.platform.arch }} + distro: ubuntu20.04 + githubToken: ${{ github.token }} + install: | + apt-get update + apt-get install -y --no-install-recommends python3 python3-pip + pip3 install -U pip + run: | + pip3 install ${{ env.PACKAGE_NAME }} --no-index --find-links dist/ --force-reinstall + ${{ env.MODULE_NAME }} --help + - name: "Upload wheels" + uses: actions/upload-artifact@v3 + with: + name: wheels + path: dist + - name: "Archive binary" + shell: bash + run: | + set -euo pipefail + + TARGET=${{ matrix.platform.target }} + ARCHIVE_NAME=puffin-$TARGET + ARCHIVE_FILE=$ARCHIVE_NAME.tar.gz + + mkdir -p $ARCHIVE_NAME + cp target/$TARGET/release/puffin $ARCHIVE_NAME/puffin + tar czvf $ARCHIVE_FILE $ARCHIVE_NAME + shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 + - name: "Upload binary" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + *.tar.gz + *.sha256 + + musllinux: + runs-on: ubuntu-latest + strategy: + matrix: + target: + - x86_64-unknown-linux-musl + - i686-unknown-linux-musl + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + architecture: x64 + - name: "Prep README.md" + run: echo "# Puffin" > README.md + - name: "Build wheels" + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.target }} + manylinux: musllinux_1_2 + args: --release --locked --out dist + - name: "Test wheel" + if: matrix.target == 'x86_64-unknown-linux-musl' + uses: addnab/docker-run-action@v3 + with: + image: alpine:latest + options: -v ${{ github.workspace }}:/io -w /io + run: | + apk add python3 + python -m venv .venv + .venv/bin/pip3 install ${{ env.PACKAGE_NAME }} --no-index --find-links dist/ --force-reinstall + .venv/bin/${{ env.MODULE_NAME }} --help + - name: "Upload wheels" + uses: actions/upload-artifact@v3 + with: + name: wheels + path: dist + - name: "Archive binary" + shell: bash + run: | + set -euo pipefail + + TARGET=${{ matrix.target }} + ARCHIVE_NAME=puffin-$TARGET + ARCHIVE_FILE=$ARCHIVE_NAME.tar.gz + + mkdir -p $ARCHIVE_NAME + cp target/$TARGET/release/puffin $ARCHIVE_NAME/puffin + tar czvf $ARCHIVE_FILE $ARCHIVE_NAME + shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 + - name: "Upload binary" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + *.tar.gz + *.sha256 + + musllinux-cross: + runs-on: ubuntu-latest + strategy: + matrix: + platform: + - target: aarch64-unknown-linux-musl + arch: aarch64 + maturin_docker_options: -e JEMALLOC_SYS_WITH_LG_PAGE=16 + - target: armv7-unknown-linux-musleabihf + arch: armv7 + + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - uses: actions/setup-python@v5 + with: + python-version: ${{ env.PYTHON_VERSION }} + - name: "Prep README.md" + run: echo "# Puffin" > README.md + - name: "Build wheels" + uses: PyO3/maturin-action@v1 + with: + target: ${{ matrix.platform.target }} + manylinux: musllinux_1_2 + args: --release --locked --out dist + docker-options: ${{ matrix.platform.maturin_docker_options }} + - uses: uraimo/run-on-arch-action@v2 + name: Test wheel + with: + arch: ${{ matrix.platform.arch }} + distro: alpine_latest + githubToken: ${{ github.token }} + install: | + apk add python3 + run: | + python -m venv .venv + .venv/bin/pip3 install ${{ env.PACKAGE_NAME }} --no-index --find-links dist/ --force-reinstall + .venv/bin/${{ env.MODULE_NAME }} --help + - name: "Upload wheels" + uses: actions/upload-artifact@v3 + with: + name: wheels + path: dist + - name: "Archive binary" + shell: bash + run: | + set -euo pipefail + + TARGET=${{ matrix.platform.target }} + ARCHIVE_NAME=puffin-$TARGET + ARCHIVE_FILE=$ARCHIVE_NAME.tar.gz + + mkdir -p $ARCHIVE_NAME + cp target/$TARGET/release/puffin $ARCHIVE_NAME/puffin + tar czvf $ARCHIVE_FILE $ARCHIVE_NAME + shasum -a 256 $ARCHIVE_FILE > $ARCHIVE_FILE.sha256 + - name: "Upload binary" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + *.tar.gz + *.sha256 diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yml similarity index 100% rename from .github/workflows/ci.yaml rename to .github/workflows/ci.yml diff --git a/.github/workflows/publish-pypi.yml b/.github/workflows/publish-pypi.yml new file mode 100644 index 000000000000..fc41f9eca790 --- /dev/null +++ b/.github/workflows/publish-pypi.yml @@ -0,0 +1,33 @@ +# Publish a release to PyPI. +# +# Assumed to run as a subworkflow of .github/workflows/release.yml; specifically, as a publish job +# within `cargo-dist`. +name: "Publish to PyPI" + +on: + workflow_call: + inputs: + plan: + required: true + type: string + +jobs: + pypi-publish: + name: Upload to PyPI + runs-on: ubuntu-latest + environment: + name: release + permissions: + # For PyPI's trusted publishing. + id-token: write + steps: + - uses: actions/download-artifact@v3 + with: + name: wheels + path: wheels + - name: Publish to PyPi + uses: pypa/gh-action-pypi-publish@release/v1 + with: + skip-existing: true + packages-dir: wheels + verbose: true diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 000000000000..84f141df03a6 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,220 @@ +# Copyright 2022-2023, axodotdev +# SPDX-License-Identifier: MIT or Apache-2.0 +# +# CI that: +# +# * checks for a Git Tag that looks like a release +# * builds artifacts with cargo-dist (archives, installers, hashes) +# * uploads those artifacts to temporary workflow zip +# * on success, uploads the artifacts to a Github Release +# +# Note that the Github Release will be created with a generated +# title/body based on your changelogs. + +name: Release + +permissions: + contents: write + +# This task will run whenever you workflow_dispatch with a tag that looks like a version +# like "1.0.0", "v0.1.0-prerelease.1", "my-app/0.1.0", "releases/v1.0.0", etc. +# Various formats will be parsed into a VERSION and an optional PACKAGE_NAME, where +# PACKAGE_NAME must be the name of a Cargo package in your workspace, and VERSION +# must be a Cargo-style SemVer Version (must have at least major.minor.patch). +# +# If PACKAGE_NAME is specified, then the announcement will be for that +# package (erroring out if it doesn't have the given version or isn't cargo-dist-able). +# +# If PACKAGE_NAME isn't specified, then the announcement will be for all +# (cargo-dist-able) packages in the workspace with that version (this mode is +# intended for workspaces with only one dist-able package, or with all dist-able +# packages versioned/released in lockstep). +# +# If you push multiple tags at once, separate instances of this workflow will +# spin up, creating an independent announcement for each one. However Github +# will hard limit this to 3 tags per commit, as it will assume more tags is a +# mistake. +# +# If there's a prerelease-style suffix to the version, then the release(s) +# will be marked as a prerelease. +on: + workflow_dispatch: + inputs: + tag: + description: Release Tag + required: true + default: dry-run + type: string + +jobs: + # Run 'cargo dist plan' (or host) to determine what tasks we need to do + plan: + runs-on: ubuntu-latest + outputs: + val: ${{ steps.plan.outputs.manifest }} + tag: ${{ (inputs.tag != 'dry-run' && inputs.tag) || '' }} + tag-flag: ${{ inputs.tag && inputs.tag != 'dry-run' && format('--tag={0}', inputs.tag) || '' }} + publishing: ${{ inputs.tag && inputs.tag != 'dry-run' }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install cargo-dist + # we specify bash to get pipefail; it guards against the `curl` command + # failing. otherwise `sh` won't catch that `curl` returned non-0 + shell: bash + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.7.3-prerelease.3/cargo-dist-installer.sh | sh" + # sure would be cool if github gave us proper conditionals... + # so here's a doubly-nested ternary-via-truthiness to try to provide the best possible + # functionality based on whether this is a pull_request, and whether it's from a fork. + # (PRs run on the *source* but secrets are usually on the *target* -- that's *good* + # but also really annoying to build CI around when it needs secrets to work right.) + - id: plan + run: | + cargo dist ${{ inputs.tag && (inputs.tag != 'dry-run' && format('host --steps=create --tag={0}', inputs.tag) || format('host --steps=create', inputs.tag)) || (github.event.pull_request.head.repo.fork && 'plan' || 'host --steps=check') }} --output-format=json > dist-manifest.json + echo "cargo dist ran successfully" + cat dist-manifest.json + echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: dist-manifest.json + + custom-build-binaries: + needs: + - plan + if: ${{ needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload' || inputs.tag == 'dry-run' }} + uses: ./.github/workflows/build-binaries.yml + with: + plan: ${{ needs.plan.outputs.val }} + secrets: inherit + + # Build and package all the platform-agnostic(ish) things + build-global-artifacts: + needs: + - plan + - custom-build-binaries + runs-on: "ubuntu-20.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/global-dist-manifest.json + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install cargo-dist + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.7.3-prerelease.3/cargo-dist-installer.sh | sh" + # Get all the local artifacts for the global tasks to use (for e.g. checksums) + - name: Fetch local artifacts + uses: actions/download-artifact@v3 + with: + name: artifacts + path: target/distrib/ + - id: cargo-dist + shell: bash + run: | + cargo dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json + echo "cargo dist ran successfully" + + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".artifacts[]?.path | select( . != null )" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: "Upload artifacts" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + # Determines if we should publish/announce + host: + needs: + - plan + - build-global-artifacts + # Only run if we're "publishing", and only if local and global didn't fail (skipped is fine) + if: ${{ always() && needs.plan.outputs.publishing == 'true' && (needs.build-global-artifacts.result == 'skipped' || needs.build-global-artifacts.result == 'success') }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + runs-on: "ubuntu-20.04" + outputs: + val: ${{ steps.host.outputs.manifest }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install cargo-dist + run: "curl --proto '=https' --tlsv1.2 -LsSf https://github.com/axodotdev/cargo-dist/releases/download/v0.7.3-prerelease.3/cargo-dist-installer.sh | sh" + # Fetch artifacts from scratch-storage + - name: Fetch artifacts + uses: actions/download-artifact@v3 + with: + name: artifacts + path: target/distrib/ + # This is a harmless no-op for Github Releases, hosting for that happens in "announce" + - id: host + shell: bash + run: | + cargo dist host ${{ needs.plan.outputs.tag-flag }} --steps=upload --steps=release --output-format=json > dist-manifest.json + echo "artifacts uploaded and released successfully" + cat dist-manifest.json + echo "manifest=$(jq -c "." dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: "Upload dist-manifest.json" + uses: actions/upload-artifact@v3 + with: + name: artifacts + path: dist-manifest.json + + custom-publish-pypi: + needs: + - plan + - host + if: ${{ !fromJson(needs.plan.outputs.val).announcement_is_prerelease || fromJson(needs.plan.outputs.val).publish_prereleases }} + uses: ./.github/workflows/publish-pypi.yml + with: + plan: ${{ needs.plan.outputs.val }} + secrets: inherit + # publish jobs get escalated permissions + permissions: + id-token: write + packages: write + + # Create a Github Release while uploading all files to it + announce: + needs: + - plan + - host + - custom-publish-pypi + # use "always() && ..." to allow us to wait for all publish jobs while + # still allowing individual publish jobs to skip themselves (for prereleases). + # "host" however must run to completion, no skipping allowed! + if: ${{ always() && needs.host.result == 'success' && (needs.custom-publish-pypi.result == 'skipped' || needs.custom-publish-pypi.result == 'success') }} + runs-on: "ubuntu-20.04" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: "Download Github Artifacts" + uses: actions/download-artifact@v3 + with: + name: artifacts + path: artifacts + - name: Cleanup + run: | + # Remove the granular manifests + rm -f artifacts/*-dist-manifest.json + - name: Create Github Release + uses: ncipollo/release-action@v1 + with: + tag: ${{ needs.plan.outputs.tag }} + name: ${{ fromJson(needs.host.outputs.val).announcement_title }} + body: ${{ fromJson(needs.host.outputs.val).announcement_github_body }} + prerelease: ${{ fromJson(needs.host.outputs.val).announcement_is_prerelease }} + artifacts: "artifacts/*" diff --git a/Cargo.toml b/Cargo.toml index e1fdb17999cb..5c0cb5b90754 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,10 +6,10 @@ resolver = "2" [workspace.package] edition = "2021" rust-version = "1.74" -homepage = "https://astral.sh" -documentation = "https://astral.sh" -repository = "https://github.com/astral-sh/puffin" -authors = ["Astral Software Inc. "] +homepage = "https://pypi.org/project/puffin-alpha/" +documentation = "https://pypi.org/project/puffin-alpha/" +repository = "https://pypi.org/project/puffin-alpha/" +authors = ["Puffin"] license = "MIT OR Apache-2.0" [workspace.dependencies] @@ -133,3 +133,37 @@ rest_pat_in_fully_bound_structs = "warn" [profile.profiling] inherits = "release" debug = true + +# The profile that 'cargo dist' will build with. +[profile.dist] +inherits = "release" +lto = "thin" + +# Config for 'cargo dist' +[workspace.metadata.dist] +# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.7.3-prerelease.3" +# CI backends to support +ci = ["github"] +# The installers to generate for each app +installers = ["shell", "powershell"] +# The archive format to use for windows builds (defaults .zip) +windows-archive = ".zip" +# The archive format to use for non-windows builds (defaults .tar.xz) +unix-archive = ".tar.gz" +# Target platforms to build apps for (Rust target-triple syntax) +targets = ["aarch64-unknown-linux-gnu", "x86_64-unknown-linux-gnu", "i686-unknown-linux-gnu", "aarch64-apple-darwin", "x86_64-apple-darwin", "aarch64-unknown-linux-musl", "x86_64-unknown-linux-musl", "i686-unknown-linux-musl", "aarch64-pc-windows-msvc", "x86_64-pc-windows-msvc", "i686-pc-windows-msvc", "armv7-unknown-linux-gnueabihf", "powerpc64-unknown-linux-gnu", "powerpc64le-unknown-linux-gnu", "s390x-unknown-linux-gnu"] +# Whether to auto-include files like READMEs and CHANGELOGs (default true) +auto-includes = false +# Whether cargo-dist should create a Github Release or use an existing draft +create-release = true +# Publish jobs to run in CI +pr-run-mode = "skip" +# Whether CI should trigger releases with dispatches instead of tag pushes +dispatch-releases = true +# Whether CI should include auto-generated code to build local artifacts +build-local-artifacts = false +# Local artifacts jobs to run in CI +local-artifacts-jobs = ["./build-binaries"] +# Publish jobs to run in CI +publish-jobs = ["./publish-pypi"] diff --git a/crates/distribution-types/Cargo.toml b/crates/distribution-types/Cargo.toml index 4b87d2665d82..4ae432c57497 100644 --- a/crates/distribution-types/Cargo.toml +++ b/crates/distribution-types/Cargo.toml @@ -18,7 +18,7 @@ distribution-filename = { path = "../distribution-filename", features = ["serde" pep440_rs = { path = "../pep440-rs" } pep508_rs = { path = "../pep508-rs" } platform-tags = { path = "../platform-tags" } -puffin-git = { path = "../puffin-git" } +puffin-git = { path = "../puffin-git", features = ["vendored-openssl"] } puffin-normalize = { path = "../puffin-normalize" } pypi-types = { path = "../pypi-types" } requirements-txt = { path = "../requirements-txt" } diff --git a/crates/pep440-rs/Cargo.toml b/crates/pep440-rs/Cargo.toml index 22ccbdf86fb9..87397b5940a2 100644 --- a/crates/pep440-rs/Cargo.toml +++ b/crates/pep440-rs/Cargo.toml @@ -3,7 +3,7 @@ name = "pep440_rs" version = "0.3.12" description = "A library for python version numbers and specifiers, implementing PEP 440" license = "Apache-2.0 OR BSD-2-Clause" -include = ["/src", "Changelog.md", "License-Apache", "License-BSD", "Readme.md", "pyproject.toml"] +include = ["/src", "Changelog.md", "License-Apache", "License-BSD", "README.md", "pyproject.toml"] edition = { workspace = true } rust-version = { workspace = true } diff --git a/crates/puffin-distribution/Cargo.toml b/crates/puffin-distribution/Cargo.toml index 7012bfeda874..6a1ddd0290fb 100644 --- a/crates/puffin-distribution/Cargo.toml +++ b/crates/puffin-distribution/Cargo.toml @@ -24,7 +24,7 @@ puffin-cache = { path = "../puffin-cache" } puffin-client = { path = "../puffin-client" } puffin-extract = { path = "../puffin-extract" } puffin-fs = { path = "../puffin-fs" } -puffin-git = { path = "../puffin-git" } +puffin-git = { path = "../puffin-git", features = ["vendored-openssl"] } puffin-normalize = { path = "../puffin-normalize" } puffin-traits = { path = "../puffin-traits" } pypi-types = { path = "../pypi-types" } diff --git a/crates/puffin-installer/Cargo.toml b/crates/puffin-installer/Cargo.toml index b375ba8fa059..3072dcedabc5 100644 --- a/crates/puffin-installer/Cargo.toml +++ b/crates/puffin-installer/Cargo.toml @@ -24,7 +24,7 @@ puffin-client = { path = "../puffin-client" } puffin-distribution = { path = "../puffin-distribution" } puffin-extract = { path = "../puffin-extract" } puffin-fs = { path = "../puffin-fs" } -puffin-git = { path = "../puffin-git" } +puffin-git = { path = "../puffin-git", features = ["vendored-openssl"] } puffin-interpreter = { path = "../puffin-interpreter" } puffin-normalize = { path = "../puffin-normalize" } puffin-traits = { path = "../puffin-traits" } diff --git a/crates/puffin-resolver/Cargo.toml b/crates/puffin-resolver/Cargo.toml index 3690498c92e3..32c331e09f67 100644 --- a/crates/puffin-resolver/Cargo.toml +++ b/crates/puffin-resolver/Cargo.toml @@ -25,7 +25,7 @@ platform-tags = { path = "../platform-tags" } puffin-cache = { path = "../puffin-cache" } puffin-client = { path = "../puffin-client" } puffin-distribution = { path = "../puffin-distribution" } -puffin-git = { path = "../puffin-git" } +puffin-git = { path = "../puffin-git", features = ["vendored-openssl"] } puffin-interpreter = { path = "../puffin-interpreter" } puffin-normalize = { path = "../puffin-normalize" } puffin-traits = { path = "../puffin-traits" } diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 000000000000..4f23230c188d --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,20 @@ +[build-system] +requires = ["maturin>=1.0,<2.0"] +build-backend = "maturin" + +[project] +name = "puffin-alpha" +version = "0.0.1" +authors = [{ name = "Puffin" }] +requires-python = ">=3.7" +keywords = [] +classifiers = [] +readme = "README.md" + +[tool.maturin] +bindings = "bin" +manifest-path = "crates/puffin-cli/Cargo.toml" +module-name = "puffin" +python-source = "python" +strip = true +include = ["rust-toolchain.toml"] diff --git a/python/puffin/__init__.py b/python/puffin/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/python/puffin/__main__.py b/python/puffin/__main__.py new file mode 100644 index 000000000000..136b5d60e74e --- /dev/null +++ b/python/puffin/__main__.py @@ -0,0 +1,39 @@ +import os +import sys +import sysconfig + + +def find_puffin_bin() -> str: + """Return the puffin binary path.""" + + puffin_exe = "puffin" + sysconfig.get_config_var("EXE") + + path = os.path.join(sysconfig.get_path("scripts"), puffin_exe) + if os.path.isfile(path): + return path + + if sys.version_info >= (3, 10): + user_scheme = sysconfig.get_preferred_scheme("user") + elif os.name == "nt": + user_scheme = "nt_user" + elif sys.platform == "darwin" and sys._framework: + user_scheme = "osx_framework_user" + else: + user_scheme = "posix_user" + + path = os.path.join(sysconfig.get_path("scripts", scheme=user_scheme), puffin_exe) + if os.path.isfile(path): + return path + + raise FileNotFoundError(path) + + +if __name__ == "__main__": + puffin = os.fsdecode(find_puffin_bin()) + if sys.platform == "win32": + import subprocess + + completed_process = subprocess.run([puffin, *sys.argv[1:]]) + sys.exit(completed_process.returncode) + else: + os.execvp(puffin, [puffin, *sys.argv[1:]]) diff --git a/requirements.in b/requirements.in new file mode 100644 index 000000000000..7e66a17d49cb --- /dev/null +++ b/requirements.in @@ -0,0 +1 @@ +black