name: PR Release Publish run-name: "sign PR #${{ github.event_name == 'pull_request_target' && github.event.pull_request.number || github.event_name == 'workflow_run' && github.event.workflow_run.pull_requests[0].number || inputs.pr_number }} with the release key" on: workflow_dispatch: inputs: pr_number: description: Open pull request number required: true type: string automatic_build_run_id: description: Completed build run for automatic publishing required: false type: string pull_request_target: types: [labeled] branches: [main] workflow_run: workflows: [Build APK] types: [completed] permissions: actions: read contents: read issues: write pull-requests: write concurrency: group: pr-release-${{ github.event_name == 'pull_request_target' && github.event.pull_request.number || github.event_name == 'workflow_run' && github.event.workflow_run.pull_requests[0].number || inputs.pr_number }} cancel-in-progress: false queue: max jobs: dispatch-fork-builds: if: >- github.event_name == 'workflow_run' && github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_repository.full_name != github.repository runs-on: ubuntu-24.04 timeout-minutes: 5 permissions: actions: write pull-requests: read steps: - name: Find fork PRs for the completed build env: GH_TOKEN: ${{ github.token }} RUN_ID: ${{ github.event.workflow_run.id }} RUN_SHA: ${{ github.event.workflow_run.head_sha }} RUN_REPO: ${{ github.event.workflow_run.head_repository.full_name }} RUN_BRANCH: ${{ github.event.workflow_run.head_branch }} run: | set -euo pipefail owner=${RUN_REPO%%/*} gh api --paginate --slurp -X GET "repos/$GITHUB_REPOSITORY/pulls" \ -f state=open -f base=main -f "head=$owner:$RUN_BRANCH" -f per_page=100 | jq -r --arg sha "$RUN_SHA" --arg repo "$RUN_REPO" --arg branch "$RUN_BRANCH" ' .[][] | select(.head.sha == $sha and .head.repo.full_name == $repo and .head.ref == $branch) | .number' | while IFS= read -r number; do gh workflow run pr-release-publish.yml -R "$GITHUB_REPOSITORY" --ref main \ -f "pr_number=$number" -f "automatic_build_run_id=$RUN_ID" done authorize: if: >- (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main') || (github.event_name == 'pull_request_target' && (github.event.action != 'labeled' || github.event.label.name == 'publish-test')) || (github.event_name == 'workflow_run' && github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_repository.full_name == github.repository && github.event.workflow_run.pull_requests[0] != null) runs-on: ubuntu-24.04 timeout-minutes: 150 outputs: pr_number: ${{ steps.gate.outputs.pr_number }} run_id: ${{ steps.gate.outputs.run_id }} head_sha: ${{ steps.gate.outputs.head_sha }} base_sha: ${{ steps.gate.outputs.base_sha }} version_code: ${{ steps.gate.outputs.version_code }} label: ${{ steps.gate.outputs.label }} skip: ${{ steps.gate.outputs.skip }} automatic: ${{ steps.gate.outputs.automatic }} variants: ${{ steps.variants.outputs.list }} steps: - uses: actions/checkout@v4 with: fetch-depth: 0 persist-credentials: false - name: The packages a signed build ships as id: variants run: echo "list=$(awk '!/^#/ && NF { print $1 }' tools/release/variants.txt | jq -R . | jq -sc .)" >> "$GITHUB_OUTPUT" - name: Check the requester, PR, and build id: gate env: GH_TOKEN: ${{ github.token }} EVENT_NAME: ${{ github.event_name }} REQUESTER: ${{ github.actor }} PR_NUMBER: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.number || github.event_name == 'workflow_run' && github.event.workflow_run.pull_requests[0].number || inputs.pr_number }} ACTION: ${{ github.event.action }} BUILT_SHA: ${{ github.event.workflow_run.head_sha }} AUTO_RUN: ${{ inputs.automatic_build_run_id }} run: | set -euo pipefail [[ "$PR_NUMBER" =~ ^[1-9][0-9]*$ ]] || { echo "::error::Invalid PR number '$PR_NUMBER'"; exit 1; } skip() { echo "::notice::Not publishing PR #$PR_NUMBER: $1"; echo "skip=true" >> "$GITHUB_OUTPUT"; exit 0; } if [ "$EVENT_NAME" = pull_request_target ] && [ "$ACTION" = labeled ]; then permission=$(gh api "repos/$GITHUB_REPOSITORY/collaborators/$REQUESTER/permission" --jq .permission) case "$permission" in admin|maintain|write) ;; *) echo "::error::@$REQUESTER does not have permission to publish release-signed test builds"; exit 1 ;; esac fi pr=$(gh api "repos/$GITHUB_REPOSITORY/pulls/$PR_NUMBER") jq -e '.state == "open" and .draft == false and .base.ref == "main"' <<<"$pr" >/dev/null || skip "it must be open, ready for review, and target main" if [ "$EVENT_NAME" = workflow_run ]; then [ "$(jq -r .head.repo.full_name <<<"$pr")" = "$GITHUB_REPOSITORY" ] || skip "it comes from a fork" [ "$(jq -r .head.sha <<<"$pr")" = "$BUILT_SHA" ] || skip "a newer push is building" jq -e 'any(.labels[]; .name == "no-test-build")' <<<"$pr" >/dev/null && skip "it is labelled no-test-build" echo "automatic=true" >> "$GITHUB_OUTPUT" elif [ "$EVENT_NAME" = workflow_dispatch ] && [ -n "$AUTO_RUN" ]; then [[ "$AUTO_RUN" =~ ^[1-9][0-9]*$ ]] || { echo '::error::Invalid automatic build run ID'; exit 1; } jq -e 'any(.labels[]; .name == "no-test-build")' <<<"$pr" >/dev/null && skip "it is labelled no-test-build" git fetch --no-tags origin main opener=$(jq -r .user.login <<<"$pr") git show origin/main:.github/trusted-test-builds.txt | grep -Fixq -- "$opener" || skip "PR opener @$opener is not trusted for automatic signing" echo "automatic=true" >> "$GITHUB_OUTPUT" fi head=$(jq -r '.head.sha' <<<"$pr") base=$(jq -r '.base.sha' <<<"$pr") run_id= for attempt in $(seq 1 240); do latest=$(gh api "repos/$GITHUB_REPOSITORY/actions/workflows/build.yml/runs?event=pull_request&head_sha=$head&per_page=100" | jq -c --arg head "$head" --arg repo "$(jq -r .head.repo.full_name <<<"$pr")" --arg ref "$(jq -r .head.ref <<<"$pr")" ' [.workflow_runs[] | select(.head_sha == $head and .head_repository.full_name == $repo and .head_branch == $ref)] | sort_by([.created_at, .run_attempt]) | last // empty') if [[ -z "$latest" && "$attempt" == 1 ]]; then git fetch --no-tags origin main git fetch --no-tags origin "refs/pull/$PR_NUMBER/head" git diff --no-renames --name-only -z "$base...FETCH_HEAD" > "$RUNNER_TEMP/pr-changed-paths" excluded=true while IFS= read -r -d '' path; do case "$path" in *.md|LICENSE|.gitignore) ;; *) excluded=false; break ;; esac done < "$RUNNER_TEMP/pr-changed-paths" [ "$excluded" = false ] || skip "its changes do not trigger the APK build" fi if [[ -n "$latest" && $(jq -r .status <<<"$latest") == completed ]]; then conclusion=$(jq -r .conclusion <<<"$latest") if [[ "$conclusion" == success ]]; then run_id=$(jq -r .id <<<"$latest") if [ -n "$AUTO_RUN" ] && [ "$run_id" != "$AUTO_RUN" ]; then skip "a newer build exists" fi break fi [[ "$conclusion" == action_required ]] || { echo "::error::The latest PR build is not green ($conclusion)"; exit 1; } fi status=not-started [[ -z "$latest" ]] || status=$(jq -r .status <<<"$latest") echo "Waiting for the PR build of ${head:0:7} to finish ($status)" sleep 30 done [[ -n "$run_id" ]] || { echo '::error::The PR build did not finish within 120 minutes'; exit 1; } run=$(gh api "repos/$GITHUB_REPOSITORY/actions/runs/$run_id") jq -e --arg head "$head" --arg repo "$(jq -r .head.repo.full_name <<<"$pr")" --arg ref "$(jq -r .head.ref <<<"$pr")" ' .event == "pull_request" and .head_sha == $head and .conclusion == "success" and .head_repository.full_name == $repo and .head_branch == $ref ' <<<"$run" >/dev/null || { echo "::error::Build run $run_id is not a green build of PR #$PR_NUMBER at ${head:0:7}"; exit 1; } sdk=${ANDROID_HOME:-${ANDROID_SDK_ROOT:-}} tools=$(find "$sdk/build-tools" -mindepth 1 -maxdepth 1 -type d | sort -V | tail -1) main_code=$(sed -n 's/^[[:space:]]*versionCode[[:space:]][[:space:]]*\([0-9][0-9]*\)[[:space:]]*$/\1/p' app/build.gradle) [[ "$main_code" =~ ^[0-9]+$ ]] || { echo "::error::No numeric versionCode in main's app/build.gradle"; exit 1; } mkdir -p "$RUNNER_TEMP/pr" gh run download "$run_id" -R "$GITHUB_REPOSITORY" -n droiddeck-apk -D "$RUNNER_TEMP/pr" mapfile -t apks < <(find "$RUNNER_TEMP/pr" -type f -name '*.apk') [[ ${#apks[@]} == 1 ]] || { echo '::error::Expected one PR APK'; exit 1; } package_line() { "$tools/aapt" dump badging "$1" | sed -n "s/^package: name='\\([^']*\\)' versionCode='\\([^']*\\)'.*/\\1 \\2/p" } candidate=$(package_line "${apks[0]}") [[ "$candidate" =~ ^com\.droiddeck\.launcher\ [0-9]+$ && ${candidate##* } -ge $main_code ]] || { echo "::error::PR package/versionCode '$candidate' cannot install over main (versionCode $main_code)"; exit 1; } current=$(gh api "repos/$GITHUB_REPOSITORY/pulls/$PR_NUMBER") jq -e --arg head "$head" --arg base "$base" ' .state == "open" and .draft == false and .base.ref == "main" and .head.sha == $head and .base.sha == $base ' <<<"$current" >/dev/null || { echo "::error::PR #$PR_NUMBER moved on while its build was checked; publish again"; exit 1; } if [ "$EVENT_NAME" = workflow_run ] || { [ "$EVENT_NAME" = workflow_dispatch ] && [ -n "$AUTO_RUN" ]; }; then jq -e 'any(.labels[]; .name == "no-test-build")' <<<"$current" >/dev/null && skip "it is labelled no-test-build" if [ "$EVENT_NAME" = workflow_dispatch ]; then git fetch --no-tags origin main git show origin/main:.github/trusted-test-builds.txt | grep -Fixq -- "$(jq -r .user.login <<<"$current")" || skip "the PR opener is no longer trusted" fi fi { echo "pr_number=$PR_NUMBER" echo "run_id=$run_id" echo "head_sha=$head" echo "base_sha=$base" echo "version_code=${candidate##* }" echo "label=PR.$PR_NUMBER-${head:0:7}" } >> "$GITHUB_OUTPUT" sign: needs: authorize uses: ./.github/workflows/sign.yml with: environment: signing-main variants: ${{ needs.authorize.outputs.variants }} run_id: ${{ needs.authorize.outputs.run_id }} label: ${{ needs.authorize.outputs.label }} artifact: droiddeck-pr-signed secrets: inherit if: ${{ needs.authorize.outputs.skip != 'true' }} publish: needs: [authorize, sign] runs-on: ubuntu-24.04 outputs: keep: ${{ steps.publish.outputs.keep }} permissions: actions: read contents: read issues: write pull-requests: write steps: - uses: actions/checkout@v4 with: ref: main persist-credentials: false - uses: actions/download-artifact@v4 with: pattern: droiddeck-pr-signed-* merge-multiple: true path: signed - name: The add-on packs main has not published env: GH_TOKEN: ${{ github.token }} RUN: ${{ needs.authorize.outputs.run_id }} run: | set -euo pipefail gh run download "$RUN" -R "$GITHUB_REPOSITORY" -n droiddeck-packs -D packs mkdir -p pr-packs for file in packs/*.tar.zst; do name=$(basename "$file" .tar.zst) sha=$(sha256sum "$file" | cut -d' ' -f1) tag="pack-$name-${sha:0:16}" digest=$({ gh api "repos/Droid-Deck/DroidDeck-Components/releases/tags/$tag" 2>/dev/null || echo '{}'; } | jq -r --arg n "$name.tar.zst" '.assets // [] | .[] | select(.name == $n) | .digest // empty') if [ "$digest" = "sha256:$sha" ]; then echo "$name: served from DroidDeck-Components $tag" else cp "$file" "pr-packs/$tag.tar.zst" echo "$name: attached to the PR release as $tag.tar.zst" fi done - name: Describe the change env: GH_TOKEN: ${{ github.token }} PR_NUMBER: ${{ needs.authorize.outputs.pr_number }} run: | set -euo pipefail pr=$(gh api "repos/$GITHUB_REPOSITORY/pulls/$PR_NUMBER") title=$(jq -r .title <<<"$pr") summary=$(jq -r '.body // ""' <<<"$pr" | tr -d '\r' | { grep -v '^๐Ÿค–' || true; } | awk '!p && /^#/ { next } NF { p = 1; print; next } p { exit }' | head -n 6 | cut -c1-400) { echo "**Not merged** - a test build of open [PR #$PR_NUMBER]($GITHUB_SERVER_URL/$GITHUB_REPOSITORY/pull/$PR_NUMBER): $title" if [ -n "$summary" ]; then echo echo "$summary" fi } > notes-head.md cat notes-head.md - uses: actions/create-github-app-token@v2 id: ci-token with: app-id: ${{ vars.DROIDDECK_CI_APP_ID }} private-key: ${{ secrets.DROIDDECK_CI_APP_KEY }} owner: Droid-Deck repositories: DroidDeck-CI - name: Publish to DroidDeck-CI id: publish env: GH_TOKEN: ${{ steps.ci-token.outputs.token }} PR_NUMBER: ${{ needs.authorize.outputs.pr_number }} HEAD_SHA: ${{ needs.authorize.outputs.head_sha }} BASE_SHA: ${{ needs.authorize.outputs.base_sha }} VERSION_CODE: ${{ needs.authorize.outputs.version_code }} run: | set -euo pipefail repo=Droid-Deck/DroidDeck-CI tag="pr-$PR_NUMBER" cat signed/SHA256SUMS-*.txt > signed/SHA256SUMS.txt rm signed/SHA256SUMS-*.txt notes="$(cat notes-head.md) Source: https://github.com/$GITHUB_REPOSITORY/pull/$PR_NUMBER Commit: $HEAD_SHA Base: $BASE_SHA VersionCode: $VERSION_CODE Each apk installs over a DroidDeck release and keeps its data. \`standard\` is the normal app; the others are the same app under another package name, installed beside it. SHA-256: \`\`\` $(cat signed/SHA256SUMS.txt) \`\`\`" first=false if ! gh release view "$tag" -R "$repo" >/dev/null 2>&1; then gh release create "$tag" -R "$repo" --target main --title "PR #$PR_NUMBER" --notes "$notes" --prerelease first=true fi echo "first=$first" >> "$GITHUB_OUTPUT" cp pr-packs/* signed/ 2>/dev/null || true gh release upload "$tag" signed/* -R "$repo" --clobber gh release edit "$tag" -R "$repo" --title "PR #$PR_NUMBER" --notes "$notes" --prerelease # The previous push's files stay until the catalog names these (the prune job), so a download started from the old catalog still finds its APK. echo "keep=$(cd signed && ls | jq -R . | jq -sc .)" >> "$GITHUB_OUTPUT" published=$(gh release view "$tag" -R "$repo" --json tagName,assets) jq -e --arg tag "$tag" '.tagName == $tag and (.assets | length) > 0' <<<"$published" >/dev/null release="$GITHUB_SERVER_URL/$repo/releases/tag/$tag" apk=$(cd signed && ls DroidDeck-*.apk | awk 'length(a) == 0 || length($0) < length(a) { a = $0 } END { print a }') echo "release=$release" >> "$GITHUB_OUTPUT" echo "apk=$GITHUB_SERVER_URL/$repo/releases/download/$tag/$apk" >> "$GITHUB_OUTPUT" - name: Whether the PR opener is trusted id: trusted-opener env: GH_TOKEN: ${{ github.token }} PR_NUMBER: ${{ needs.authorize.outputs.pr_number }} run: | pr=$(gh api "repos/$GITHUB_REPOSITORY/pulls/$PR_NUMBER") opener=$(jq -r .user.login <<<"$pr") git fetch --no-tags origin main if [ "$(jq -r .head.repo.full_name <<<"$pr")" = "$GITHUB_REPOSITORY" ] || git show origin/main:.github/trusted-test-builds.txt | grep -Fixq -- "$opener"; then echo "trusted=true" >> "$GITHUB_OUTPUT" else echo "trusted=false" >> "$GITHUB_OUTPUT" fi - name: Clear the publish request label if: ${{ github.event_name == 'pull_request_target' && github.event.action == 'labeled' && steps.publish.outcome == 'success' }} env: GH_TOKEN: ${{ github.token }} PR_NUMBER: ${{ needs.authorize.outputs.pr_number }} run: | gh api --method DELETE "repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/labels/publish-test" - name: Report the signed build on the PR env: GH_TOKEN: ${{ github.token }} PR_NUMBER: ${{ needs.authorize.outputs.pr_number }} HEAD_SHA: ${{ needs.authorize.outputs.head_sha }} RELEASE: ${{ steps.publish.outputs.release }} APK: ${{ steps.publish.outputs.apk }} TRUSTED_OPENER: ${{ steps.trusted-opener.outputs.trusted }} run: | set -euo pipefail short=${HEAD_SHA:0:7} mark='' if [ "$TRUSTED_OPENER" = true ]; then NEXT='Each green build of a new push is signed and published here on its own. Label the PR `no-test-build` to stop that.' else NEXT='Pushes to this PR do not re-sign automatically. After a new green build, a maintainer can add the `publish-test` label again.' fi body=$(cat <"))' <<<"$comment") if [ -n "$state" ]; then body=$(printf '%s\n%s' "$body" "$state"); fi gh api -X PATCH "repos/$GITHUB_REPOSITORY/issues/comments/$id" -f body="$body" >/dev/null else gh api -X POST "repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/comments" -f body="$body" >/dev/null fi - name: Update the Discord PR announcement if: ${{ always() && steps.publish.outcome == 'success' }} env: WEBHOOK: ${{ secrets.DISCORD_PR_BUILDS_WEBHOOK }} GH_TOKEN: ${{ github.token }} PR_NUMBER: ${{ needs.authorize.outputs.pr_number }} HEAD_SHA: ${{ needs.authorize.outputs.head_sha }} RELEASE: ${{ steps.publish.outputs.release }} APK: ${{ steps.publish.outputs.apk }} run: python3 tools/release/pr_discord.py publish catalog: needs: publish if: ${{ always() && needs.publish.result != 'skipped' }} uses: ./.github/workflows/update-catalog.yml secrets: inherit prune: needs: [authorize, publish, catalog] if: ${{ always() && needs.publish.result == 'success' && needs.catalog.result == 'success' }} runs-on: ubuntu-24.04 timeout-minutes: 15 steps: - uses: actions/create-github-app-token@v2 id: ci-token with: app-id: ${{ vars.DROIDDECK_CI_APP_ID }} private-key: ${{ secrets.DROIDDECK_CI_APP_KEY }} owner: Droid-Deck repositories: DroidDeck-CI - name: Remove the previous push's files env: GH_TOKEN: ${{ steps.ci-token.outputs.token }} PR_NUMBER: ${{ needs.authorize.outputs.pr_number }} KEEP: ${{ needs.publish.outputs.keep }} run: | set -euo pipefail repo=Droid-Deck/DroidDeck-CI tag="pr-$PR_NUMBER" # An app that read the catalog just before it changed may still be starting that download. sleep 300 # Delete nothing the published catalog still names. named=$(gh api -H "Accept: application/vnd.github.raw+json" "repos/$repo/contents/catalog.json?ref=main" | jq -c --argjson pr "$PR_NUMBER" '[.tests[] | select(.pr == $pr) | .apks[].name]') stale=$(jq -nr --argjson named "$named" --argjson keep "$KEEP" '$named - $keep | join(" ")') if [ -n "$stale" ]; then echo "::warning::The catalog still names $stale; keeping every file of $tag" exit 0 fi gh api "repos/$repo/releases/tags/$tag" | jq -r --argjson keep "$KEEP" '.assets[] | select(.name as $n | $keep | index($n) | not) | .id' | while IFS= read -r id; do gh api --method DELETE "repos/$repo/releases/assets/$id" >/dev/null done