Skip to content

Allow releasing specific commits, and publishing immediately #868

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stpierre merged 2 commits into from
Sep 10, 2026
Merged

Allow releasing specific commits, and publishing immediately #868

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb0a862
Allow releasing specific commits, and publishing immediately
stpierre Sep 9, 2026
67038fa
Mark automatically-published releases as latest
stpierre Sep 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 53 additions & 2 deletions .github/workflows/create-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,22 @@ on:
description: An ID used by external tools to identify workflow runs(can be left empty when running manually)
default: "none"
type: string
api_ref:
description: "api commit or ref to release; defaults to `branch`"
default: ""
type: string
api_go_ref:
description: "api-go commit or ref to release; defaults to `branch`"
default: ""
type: string
auto_publish:
description: "Publish the release instead of leaving a draft. A draft creates no tag, so automated callers need this."
default: false
type: boolean

permissions:
contents: read

jobs:
dispatch:
runs-on: ubuntu-latest
Expand All @@ -33,10 +49,15 @@ jobs:
api_commit_sha: ${{ steps.pin_commits.outputs.api_commit_sha }}
api_go_commit_sha: ${{ steps.pin_commits.outputs.api_go_commit_sha }}
steps:
# api_ref/api_go_ref let a caller release specific commits rather than
# the head of a branch. They must name a corresponding pair: the "Pin
# commits sha" step below asserts that the api-go commit's proto/api
# submodule points at the api commit. Left empty, both fall back to
# `branch`.
- name: Checkout api
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
ref: ${{ github.event.inputs.branch }}
ref: ${{ inputs.api_ref || inputs.branch }}
fetch-depth: 0
fetch-tags: true
path: api
Expand All @@ -45,7 +66,7 @@ jobs:
uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
repository: temporalio/api-go
ref: ${{ github.event.inputs.branch }}
ref: ${{ inputs.api_go_ref || inputs.branch }}
submodules: true
path: api-go

Expand Down Expand Up @@ -141,3 +162,33 @@ jobs:
api_commit_sha: ${{ needs.prepare-inputs.outputs.api_commit_sha }}
base_tag: ${{ github.event.inputs.base_tag }}
secrets: inherit

# Publishing this repo's release fires `release: published`, which
# trigger-api-go-publish-release.yml turns into api-go's publish-release.yml
# -- the step that actually creates the api-go tag.
publish-release:
name: "Publish release"
needs:
- create-release
- release-api-go
if: |
!cancelled() &&
(inputs.auto_publish == true || inputs.auto_publish == 'true') &&

@stephanos stephanos Sep 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When would we need the == 'true' part? Isn't it always boolean since it's an input?

@stpierre stpierre Sep 10, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it always boolean since it's an input?

If Github Actions was even just a moderately terrible system, yes. But instead, no. workflow_call events pass booleans as booleans, but workflow_dispatch events pass them as strings. Even though this WF currently only has a workflow_dispatch trigger, adding both is smart forward-compatibility, because someone adding a workflow_call trigger would not necessarily suspect that the exact same input variable might be a boolean in one case and a string in another, even though it's declared as a boolean in both.

@stephanos stephanos Sep 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha; ok that makes sense 👍

needs.create-release.result == 'success' &&
needs.release-api-go.result == 'success'
runs-on: ubuntu-latest

steps:
- name: Generate token
id: generate_token
uses: actions/create-github-app-token@d72941d797fd3113feb6b93fd0dec494b13a2547 # v1.12.0
with:
app-id: ${{ secrets.TEMPORAL_CICD_APP_ID }}
private-key: ${{ secrets.TEMPORAL_CICD_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}

- name: Publish release
env:
GH_TOKEN: ${{ steps.generate_token.outputs.token }}
TAG: ${{ github.event.inputs.tag }}
run: gh release edit "$TAG" --draft=false -R "$GITHUB_REPOSITORY" --latest
Loading