From cd692fb990127cb2aaa4ba9bc20394aee66bb077 Mon Sep 17 00:00:00 2001 From: Oliver Browne Date: Tue, 18 Mar 2025 12:08:53 +0200 Subject: [PATCH] chore(err): add posthog-cli release publishing CI (#30062) --- .github/workflows/release.yml | 291 ++++++++++++++++++++++++++++ dist-workspace.toml | 26 +++ rust/Cargo.toml | 5 + rust/batch-import-worker/Cargo.toml | 1 + rust/capture/Cargo.toml | 1 + rust/cyclotron-core/Cargo.toml | 3 +- rust/cyclotron-fetch/Cargo.toml | 1 + rust/cyclotron-janitor/Cargo.toml | 1 + rust/cyclotron-node/Cargo.toml | 3 +- rust/cymbal/Cargo.toml | 1 + rust/feature-flags/Cargo.toml | 3 +- rust/hook-api/Cargo.toml | 1 + rust/hook-common/Cargo.toml | 1 + rust/hook-janitor/Cargo.toml | 1 + rust/hook-worker/Cargo.toml | 1 + rust/posthog-cli/Cargo.toml | 2 + rust/posthog-cli/README.md | 32 +++ rust/property-defs-rs/Cargo.toml | 3 +- 18 files changed, 373 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/release.yml create mode 100644 dist-workspace.toml create mode 100644 rust/posthog-cli/README.md diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000000..1d17d291fe --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,291 @@ +# This file was autogenerated by dist: https://opensource.axo.dev/cargo-dist/ +# +# Copyright 2022-2024, axodotdev +# SPDX-License-Identifier: MIT or Apache-2.0 +# +# CI that: +# +# * checks for a Git Tag that looks like a release +# * builds artifacts with 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 push a git 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 dist-able). +# +# If PACKAGE_NAME isn't specified, then the announcement will be for all +# (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: + pull_request: + push: + tags: + - '**[0-9]+.[0-9]+.[0-9]+*' + +jobs: + # Run 'dist plan' (or host) to determine what tasks we need to do + plan: + runs-on: 'ubuntu-20.04' + outputs: + val: ${{ steps.plan.outputs.manifest }} + tag: ${{ !github.event.pull_request && github.ref_name || '' }} + tag-flag: ${{ !github.event.pull_request && format('--tag={0}', github.ref_name) || '' }} + publishing: ${{ !github.event.pull_request }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install 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.28.0/cargo-dist-installer.sh | sh" + - name: Cache dist + uses: actions/upload-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/dist + # 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: | + dist ${{ (!github.event.pull_request && format('host --steps=create --tag={0}', github.ref_name)) || 'plan' }} --output-format=json > plan-dist-manifest.json + echo "dist ran successfully" + cat plan-dist-manifest.json + echo "manifest=$(jq -c "." plan-dist-manifest.json)" >> "$GITHUB_OUTPUT" + - name: 'Upload dist-manifest.json' + uses: actions/upload-artifact@v4 + with: + name: artifacts-plan-dist-manifest + path: plan-dist-manifest.json + + # Build and packages all the platform-specific things + build-local-artifacts: + name: build-local-artifacts (${{ join(matrix.targets, ', ') }}) + # Let the initial task tell us to not run (currently very blunt) + needs: + - plan + if: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix.include != null && (needs.plan.outputs.publishing == 'true' || fromJson(needs.plan.outputs.val).ci.github.pr_run_mode == 'upload') }} + strategy: + fail-fast: false + # Target platforms/runners are computed by dist in create-release. + # Each member of the matrix has the following arguments: + # + # - runner: the github runner + # - dist-args: cli flags to pass to dist + # - install-dist: expression to run to install dist on the runner + # + # Typically there will be: + # - 1 "global" task that builds universal installers + # - N "local" tasks that build each platform's binaries and platform-specific installers + matrix: ${{ fromJson(needs.plan.outputs.val).ci.github.artifacts_matrix }} + runs-on: ${{ matrix.runner }} + container: ${{ matrix.container && matrix.container.image || null }} + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BUILD_MANIFEST_NAME: target/distrib/${{ join(matrix.targets, '-') }}-dist-manifest.json + steps: + - name: enable windows longpaths + run: | + git config --global core.longpaths true + - uses: actions/checkout@v4 + with: + submodules: recursive + - name: Install Rust non-interactively if not already installed + if: ${{ matrix.container }} + run: | + if ! command -v cargo > /dev/null 2>&1; then + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y + echo "$HOME/.cargo/bin" >> $GITHUB_PATH + fi + - name: Install dist + run: ${{ matrix.install_dist.run }} + # Get the dist-manifest + - name: Fetch local artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - name: Install dependencies + run: | + ${{ matrix.packages_install }} + - name: Build artifacts + run: | + # Actually do builds and make zips and whatnot + dist build ${{ needs.plan.outputs.tag-flag }} --print=linkage --output-format=json ${{ matrix.dist_args }} > dist-manifest.json + echo "dist ran successfully" + - id: cargo-dist + name: Post-build + # We force bash here just because github makes it really hard to get values up + # to "real" actions without writing to env-vars, and writing to env-vars has + # inconsistent syntax between shell and powershell. + shell: bash + run: | + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + dist print-upload-files-from-manifest --manifest dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: 'Upload artifacts' + uses: actions/upload-artifact@v4 + with: + name: artifacts-build-local-${{ join(matrix.targets, '_') }} + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + + # Build and package all the platform-agnostic(ish) things + build-global-artifacts: + needs: + - plan + - build-local-artifacts + 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 cached dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/dist + # Get all the local artifacts for the global tasks to use (for e.g. checksums) + - name: Fetch local artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - id: cargo-dist + shell: bash + run: | + dist build ${{ needs.plan.outputs.tag-flag }} --output-format=json "--artifacts=global" > dist-manifest.json + echo "dist ran successfully" + + # Parse out what we just built and upload it to scratch storage + echo "paths<> "$GITHUB_OUTPUT" + jq --raw-output ".upload_files[]" dist-manifest.json >> "$GITHUB_OUTPUT" + echo "EOF" >> "$GITHUB_OUTPUT" + + cp dist-manifest.json "$BUILD_MANIFEST_NAME" + - name: 'Upload artifacts' + uses: actions/upload-artifact@v4 + with: + name: artifacts-build-global + path: | + ${{ steps.cargo-dist.outputs.paths }} + ${{ env.BUILD_MANIFEST_NAME }} + # Determines if we should publish/announce + host: + needs: + - plan + - build-local-artifacts + - 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') && (needs.build-local-artifacts.result == 'skipped' || needs.build-local-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 cached dist + uses: actions/download-artifact@v4 + with: + name: cargo-dist-cache + path: ~/.cargo/bin/ + - run: chmod +x ~/.cargo/bin/dist + # Fetch artifacts from scratch-storage + - name: Fetch artifacts + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: target/distrib/ + merge-multiple: true + - id: host + shell: bash + run: | + 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@v4 + with: + # Overwrite the previous copy + name: artifacts-dist-manifest + path: dist-manifest.json + # Create a GitHub Release while uploading all files to it + - name: 'Download GitHub Artifacts' + uses: actions/download-artifact@v4 + with: + pattern: artifacts-* + path: artifacts + merge-multiple: true + - name: Cleanup + run: | + # Remove the granular manifests + rm -f artifacts/*-dist-manifest.json + - name: Create GitHub Release + env: + PRERELEASE_FLAG: "${{ fromJson(steps.host.outputs.manifest).announcement_is_prerelease && '--prerelease' || '' }}" + ANNOUNCEMENT_TITLE: '${{ fromJson(steps.host.outputs.manifest).announcement_title }}' + ANNOUNCEMENT_BODY: '${{ fromJson(steps.host.outputs.manifest).announcement_github_body }}' + RELEASE_COMMIT: '${{ github.sha }}' + run: | + # Write and read notes from a file to avoid quoting breaking things + echo "$ANNOUNCEMENT_BODY" > $RUNNER_TEMP/notes.txt + + gh release create "${{ needs.plan.outputs.tag }}" --target "$RELEASE_COMMIT" $PRERELEASE_FLAG --title "$ANNOUNCEMENT_TITLE" --notes-file "$RUNNER_TEMP/notes.txt" artifacts/* + + announce: + needs: + - plan + - host + # 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' }} + runs-on: 'ubuntu-20.04' + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + steps: + - uses: actions/checkout@v4 + with: + submodules: recursive diff --git a/dist-workspace.toml b/dist-workspace.toml new file mode 100644 index 0000000000..71c67fbbaa --- /dev/null +++ b/dist-workspace.toml @@ -0,0 +1,26 @@ +[workspace] +members = ["cargo:./rust"] + +# Config for 'dist' +[dist] +allow-dirty = ["ci"] # Our workflow formatting disagrees with dists +# The preferred dist version to use in CI (Cargo.toml SemVer syntax) +cargo-dist-version = "0.28.0" +# CI backends to support +ci = "github" +# The installers to generate for each app +installers = ["shell", "powershell"] +# Target platforms to build apps for (Rust target-triple syntax) +targets = [ + "aarch64-apple-darwin", + "aarch64-unknown-linux-gnu", + "aarch64-pc-windows-msvc", + "x86_64-apple-darwin", + "x86_64-unknown-linux-gnu", + "x86_64-unknown-linux-musl", + "x86_64-pc-windows-msvc", +] +# Path that installers should place binaries in +install-path = "~/.posthog" +# Whether to install an updater program +install-updater = true diff --git a/rust/Cargo.toml b/rust/Cargo.toml index 67dce3bac9..14887ca107 100644 --- a/rust/Cargo.toml +++ b/rust/Cargo.toml @@ -106,3 +106,8 @@ posthog-rs = { version = "0.3.5", features = ["async-client"] } # Used for decrypting django encrypted fields fernet = "0.2" + +# The profile that 'dist' will build with +[profile.dist] +inherits = "release" +lto = "thin" diff --git a/rust/batch-import-worker/Cargo.toml b/rust/batch-import-worker/Cargo.toml index 3e4c145294..9bba562e1f 100644 --- a/rust/batch-import-worker/Cargo.toml +++ b/rust/batch-import-worker/Cargo.toml @@ -2,6 +2,7 @@ name = "batch-import-worker" version = "0.0.1" edition = "2021" +publish = false [lints] workspace = true diff --git a/rust/capture/Cargo.toml b/rust/capture/Cargo.toml index 0412ddf890..f636a53a56 100644 --- a/rust/capture/Cargo.toml +++ b/rust/capture/Cargo.toml @@ -2,6 +2,7 @@ name = "capture" version = "0.1.0" edition = "2021" +publish = false [lints] workspace = true diff --git a/rust/cyclotron-core/Cargo.toml b/rust/cyclotron-core/Cargo.toml index 29f5a506d8..9f9327608d 100644 --- a/rust/cyclotron-core/Cargo.toml +++ b/rust/cyclotron-core/Cargo.toml @@ -3,6 +3,7 @@ name = "cyclotron-core" version = "0.1.0" edition = "2021" rust-version = "1.82.0" # please keep in sync with the version in .github/workflows/rust.yml +publish = false [lints] workspace = true @@ -15,4 +16,4 @@ tokio = { workspace = true } thiserror = { workspace = true } uuid = { workspace = true } futures = { workspace = true } -tracing = { workspace = true } \ No newline at end of file +tracing = { workspace = true } diff --git a/rust/cyclotron-fetch/Cargo.toml b/rust/cyclotron-fetch/Cargo.toml index 8de85020ea..36092035bc 100644 --- a/rust/cyclotron-fetch/Cargo.toml +++ b/rust/cyclotron-fetch/Cargo.toml @@ -2,6 +2,7 @@ name = "cyclotron-fetch" version = "0.1.0" edition = "2021" +publish = false [lints] workspace = true diff --git a/rust/cyclotron-janitor/Cargo.toml b/rust/cyclotron-janitor/Cargo.toml index 15a0ae4e41..5b04dcc72e 100644 --- a/rust/cyclotron-janitor/Cargo.toml +++ b/rust/cyclotron-janitor/Cargo.toml @@ -2,6 +2,7 @@ name = "cyclotron-janitor" version = "0.1.0" edition = "2021" +publish = false [lints] workspace = true diff --git a/rust/cyclotron-node/Cargo.toml b/rust/cyclotron-node/Cargo.toml index 0ae8919968..a95f4fb4e5 100644 --- a/rust/cyclotron-node/Cargo.toml +++ b/rust/cyclotron-node/Cargo.toml @@ -3,6 +3,7 @@ name = "cyclotron-node" version = "0.1.0" edition = "2021" exclude = ["index.node"] +publish = false [lints] workspace = true @@ -19,4 +20,4 @@ tokio = { workspace = true } serde_json = { workspace = true } serde = { workspace = true } uuid = { workspace = true } -chrono = { workspace = true } \ No newline at end of file +chrono = { workspace = true } diff --git a/rust/cymbal/Cargo.toml b/rust/cymbal/Cargo.toml index e5527719e7..d84c989f93 100644 --- a/rust/cymbal/Cargo.toml +++ b/rust/cymbal/Cargo.toml @@ -2,6 +2,7 @@ name = "cymbal" version = "0.1.0" edition = "2021" +publish = false [dependencies] tokio = { workspace = true } diff --git a/rust/feature-flags/Cargo.toml b/rust/feature-flags/Cargo.toml index b61c648b93..95d473040c 100644 --- a/rust/feature-flags/Cargo.toml +++ b/rust/feature-flags/Cargo.toml @@ -2,6 +2,7 @@ name = "feature-flags" version = "0.1.0" edition = "2021" +publish = false # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html @@ -54,4 +55,4 @@ workspace = true [dev-dependencies] assert-json-diff = { workspace = true } reqwest = { workspace = true } -futures = "0.3.30" +futures = "0.3.30" diff --git a/rust/hook-api/Cargo.toml b/rust/hook-api/Cargo.toml index 87057fa8c7..b35a12c3f3 100644 --- a/rust/hook-api/Cargo.toml +++ b/rust/hook-api/Cargo.toml @@ -2,6 +2,7 @@ name = "hook-api" version = "0.1.0" edition = "2021" +publish = false [lints] workspace = true diff --git a/rust/hook-common/Cargo.toml b/rust/hook-common/Cargo.toml index b63d7bfd5d..53f8eb8238 100644 --- a/rust/hook-common/Cargo.toml +++ b/rust/hook-common/Cargo.toml @@ -2,6 +2,7 @@ name = "hook-common" version = "0.1.0" edition = "2021" +publish = false [lints] workspace = true diff --git a/rust/hook-janitor/Cargo.toml b/rust/hook-janitor/Cargo.toml index 70d6e26329..60a1a27b7c 100644 --- a/rust/hook-janitor/Cargo.toml +++ b/rust/hook-janitor/Cargo.toml @@ -2,6 +2,7 @@ name = "hook-janitor" version = "0.1.0" edition = "2021" +publish = false [lints] workspace = true diff --git a/rust/hook-worker/Cargo.toml b/rust/hook-worker/Cargo.toml index 4670116572..5f15a6318d 100644 --- a/rust/hook-worker/Cargo.toml +++ b/rust/hook-worker/Cargo.toml @@ -2,6 +2,7 @@ name = "hook-worker" version = "0.1.0" edition = "2021" +publish = false [lints] workspace = true diff --git a/rust/posthog-cli/Cargo.toml b/rust/posthog-cli/Cargo.toml index 60931e0875..14fb5f5299 100644 --- a/rust/posthog-cli/Cargo.toml +++ b/rust/posthog-cli/Cargo.toml @@ -10,6 +10,8 @@ description = "The command line interface for PostHog 🦔" homepage = "https://posthog.com" license = "MIT" edition = "2021" +repository = "https://github.com/PostHog/posthog" +readme = "README.md" [[bin]] name = "posthog-cli" diff --git a/rust/posthog-cli/README.md b/rust/posthog-cli/README.md new file mode 100644 index 0000000000..0703ca04c0 --- /dev/null +++ b/rust/posthog-cli/README.md @@ -0,0 +1,32 @@ +# The Posthog CLI + +```bash +> posthog-cli --help +The command line interface for PostHog 🦔 + +Usage: posthog-cli [OPTIONS] + +Commands: + login Authenticate with PostHog, storing a personal API token locally + query Run a SQL query against any data you have in posthog. This is mostly for fun, and subject to change + sourcemap Upload a directory of bundled chunks to PostHog + help Print this message or the help of the given subcommand(s) + +Options: + --host The PostHog host to connect to [default: https://us.posthog.com] + -h, --help Print help + -V, --version Print version +``` + +## Releases + +Releases are cut by pushing a release tag to the repository, for the `posthog-cli` app, e.g. +``` +git tag "posthog-cli-v0.1.0-prerelease.1" +git push +git push --tags +``` + +We manage publishing releases through [`cargo-dist`](https://github.com/axodotdev/cargo-dist) + +We release semi-regularly, as new features are added. If a release breaks your CI or workflow, please open an issue on GitHub, and tag one or all of the crate authors diff --git a/rust/property-defs-rs/Cargo.toml b/rust/property-defs-rs/Cargo.toml index 7acc9099e9..6967b8a961 100644 --- a/rust/property-defs-rs/Cargo.toml +++ b/rust/property-defs-rs/Cargo.toml @@ -2,12 +2,13 @@ name = "property-defs-rs" version = "0.1.0" edition = "2021" +publish = false [dependencies] serde = { workspace = true } serde_json = { workspace = true } tokio = { workspace = true } -envconfig = {workspace = true } +envconfig = { workspace = true } tracing = { workspace = true } tracing-subscriber = { workspace = true } sqlx = { workspace = true }