Repository navigation
Releases
4.3.0
Added
- github-release, swiftpm-cask-release, macos-cask-release,
claude-plugin-release, swift-package-ci, ios-ci,
claude-plugin-ci, vapor-ci: an optional last step that asks
armcknight/mcknight.io to refresh its projects page, with a
repository_dispatchofevent_type: release-published. The release
workflows send it after the release is published; the CI workflows send it
from a newnotify-sitejob, only on apushto the default branch, never
underpull_request. It runs only with the new optionalSITE_DISPATCH_TOKEN
secret, which the caller passes withsecrets: inheritor by name; without
it the step does nothing, so no caller change is needed. The script is
scripts/site/notify.sh. In ios-ci, the Authorize job now skips a
push, which it could never pass, so a push runs only the notification. - github-release: the optional
major-aliasinput. Set it totrueto
move the major alias tag that callers pin (2for the tag 2.1.0,v1for
v1.2.3) to the tag after a final release. It never moves for a release
candidate, refuses a tag the default branch does not contain, and leaves the
alias alone when a newer final release of the same major exists. The work is
inscripts/release/move-major-alias.sh. No caller change is needed: the
input is off by default. - This repository's own
release.ymlnow callsgithub-release.ymlwith
major-alias: truein place of its copy of the two jobs, so every release
here goes through the shared workflow.
Changed
- ios-ci, ota-refresh, ota-cleanup, macos-cask-release,
swiftpm-cask-release, github-release, claude-plugin-release: the
work their steps did inrun:blocks is now in the scripts in
scripts/staging/,scripts/xcode/,scripts/signing/and
scripts/release/, as for vapor-ci and fly-deploy. The steps check the
scripts out at the workflow's commit and only set their variables, so the
same operations run on a workstation or on a different CI provider. Every
reusable workflow, vapor-ci and fly-deploy too, checks the scripts out with
one step, the newscriptscomposite action. No caller change is needed.
The changes in behavior:- ios-ci: the Stage job fails with a named error when
MATCH_DEPLOY_KEY
is empty, in place of a later match failure. - macos-cask-release: the cask bump authenticates its push with a
credential helper, as swiftpm-cask-release does, so the tap token is no
longer written into the clone's.git/config. - swiftpm-cask-release: with
sign: true, the release fails when the
certificate match fetches belongs to a team other thanteam-id, as
macos-cask-release already does.
- ios-ci: the Stage job fails with a named error when
- ios-ci, swift-package-ci:
scripts/ios/ui-screenshots.shhas a
runsubcommand andscripts/swift-package/cli-examples.shabuild
subcommand, for the steps that ran the UI tests and built the product
inline. - swift-package-ci: the Python that reads the commands from a PR
description'scli-examplesmarker is now its own file,
scripts/swift-package/cli-examples-commands.py, not inline in
cli-examples.sh. No change in behavior. - ci:
make lintand theciworkflow also shellcheck the scripts in
.github/actions/.
Fixed
- ios-ci, ota-refresh, swift-package-ci: run the
stale-comments,
build-expiry,ui-screenshotsandcli-examplesscripts at the commit of
the workflow, not atmain. They are now inscripts/(pr/,staging/,
ios/andswift-package/), and each job checks them out at
job.workflow_sha;scripts/staging/publish.shandrefresh.shcall them
there, not onPATH. Before, the jobs used them through composite actions
pinned to@main, so a caller pinned to a tag ran an older workflow with the
newest scripts, and a change to a script's interface onmaincould break
it. No caller change. - swiftpm-cask-release: the README now names the signing inputs and secrets
the workflow reads —match-git-url,team-id,bundle-id,
MATCH_PASSWORDandMATCH_DEPLOY_KEY— in place of
DEVELOPER_ID_P12_BASE64andDEVELOPER_ID_P12_PASSWORD, and lists the
submodulesinput. Docs only; the workflow does not change. - claude-plugin-ci, claude-plugin-release: pass
plugin-path,
marketplace-pathandchangelogtorun:steps throughenv:, not as
inline${{ inputs.* }}expressions. Before, a value with a quote or$(in
it ran as shell.
Deprecated
- The
stale-comments,build-expiry,ui-screenshotsandcli-examples
composite actions in.github/actions/. Workflows of 4.2.0 and earlier use
them at@main, so they stay, and run the scripts inscripts/. They go in
the next major version: move a pin of 4.2.0 or earlier to this release before
then.
4.2.0
Added
- vapor-ci: a new workflow for Vapor servers. It builds and tests the
package on Linux, in the swift image the server's Dockerfile builds in, and
builds the Docker image without pushing it.swift-package-ci.ymlstays the
macOS build for packages. - fly-deploy: a new workflow that deploys a Fly app from the tip of the
default branch with--build-arg GIT_SHA=<commit>, then waits until the
health check answers with that commit.deploy-on: manual(the default)
deploys only onworkflow_dispatch;mergealso deploys on each push to the
default branch. It refuses a commit that is not the branch's tip. It needs the
FLY_API_TOKENsecret, a deploy token for the app. - scripts/: the shell scripts that
vapor-ci.ymlandfly-deploy.yml
run, inscripts/vapor/andscripts/fly/. They have no dependency on
GitHub Actions, so they also run locally or on a different CI provider. The
workflows check them out at their own commit.make lintand theci
workflow shellcheck them, and a change to them needs a changelog entry, as a
change to.github/does. - ios-ci, vapor-ci, fly-deploy: an optional
working-directory
input, default., for a repository that keeps each component in its own
directory, such asios/andserver/. Every step that runs in the
repository runs there, and paths such as the IPA, the test report, the
Dockerfile andfly.tomlare relative to it. In ios-ci,
ui-screenshots-pathis relative to it too. The default keeps today's
behaviour.
4.1.0
Added
- swiftpm-cask-release: rewrites the cask's
binarylines from the
binariesinput on every release, so the cask always links what the archive
holds. Before, onlyversionandsha256moved, and a new executable stayed
unlinked until someone edited the tap by hand. The cask must already have at
least onebinaryline; a cask with none fails the release with an error.
4.0.0
Changed
-
ios-ci, ota-refresh: the command for a new staging build is
/build-staging, not/staging-build, so it agrees with/refresh-staging.
The comments these workflows post name the new command. -
ios-ci, ota-refresh: the workflows check the command text
themselves, so a caller no longer gates itsissue_commenttrigger. A
command rename is then a change in this repo only. Each check is a job-level
if:, so any other comment skips the jobs before a runner starts. The
commenter'sauthor_associationis checked in the jobs, as before. -
ios-ci: a new optional
rebuildinput. The refresh caller'srebuildjob
sets it, so that a/refresh-stagingcomment can start the build of an
expired staging build. -
stale-comments:
/build-stagingcomments are hidden as answered. Old
/staging-buildcomments are hidden too.Caller migration
In
.github/workflows/staging-build.yml, delete theif:of thestage
job. In.github/workflows/refresh-staging-link.yml, delete theif:of the
refreshjob, and if it has arebuildjob, addrebuild: trueto that
job'swith:. Then move theios-ci.ymlandota-refresh.ymlpins to@4.
See the README's caller examples.
Fixed
- ios-ci: when the Stage job could not look up the PR's head branch, for
example because of a network error, it checked out and staged the default
branch, and the install link named the default branch's commit. It now tries
the lookup three times, then fails.
3.1.0
Added
- swift-package-ci: a new optional
cli-examples-productinput turns on a
cli-examplesjob underpull_request. It runs the commands that a
<!-- cli-examples: … -->marker in the PR description names, on the base
branch and on the PR, and comments a diff of their output on the PR. The
caller must grantpull-requests: writefor the comment. - stale-comments: a new
clikind for thecli-examplescomment, so only
the newest one stays visible.
3.0.0
Changed
-
ios-ci: a staging build is on demand. Under
pull_requestthe workflow
runs only the tests and the UI screenshots; the Stage job runs only when the
caller setspr-numberfrom another event, such as a/staging-buildPR
comment. A new Authorize job runs first in that case, before any job checks
out the PR's code: it refuses a commenter who cannot write to the repo, a
missingpr-number, and a PR that is closed or from a fork, and it reacts to
the comment. The install-link comment names/staging-buildfor a new build. -
ota-refresh: when the build is missing, the comment tells you to comment
/staging-build, not to push a new commit. -
stale-comments:
/staging-buildcomments are hidden as answered, the
same as/refresh-stagingcomments.Caller migration
iOS apps that want staging builds: add
.github/workflows/staging-build.yml
from the README's caller examples, with the sameipa-nameandarkana-keys
asci.yml, and move theios-ci.ymlpins to@3.ci.ymlneeds no edit.
2.2.0
Added
- ota-refresh: after it posts the refreshed install link, hide the PR's
earlier install-link comments (the original "Staging build ready" from
ios-ciand any prior refreshes) as outdated, so only the current link stays
visible. It also hides the/refresh-stagingcommand comments and the
notices of earlier refreshes (a missing build, or an expired one being
rebuilt). Best-effort: a comment that cannot be hidden logs a warning and does
not fail the refresh. No caller change. - ota-refresh: when the PR has no build to re-sign (the bucket's lifecycle
rule deleted it, or an explicitrun-iddoes not exist), comment the reason
and the way to get a new build on the PR, and write an::error::
annotation, instead of failing with only a log line. An explicitrun-idis
now checked beforeota-publishruns. No caller change. - ota-refresh: new optional inputs
rebuild-expired(defaultfalse) and
retention-days(default30), and arebuildoutput. With
rebuild-expired, a build older thanretention-daysthat the bucket has
deleted setsrebuildinstead of failing, so a caller job can run
ios-ci.ymlfor the PR. See the README's refresh caller example. - ios-ci: new optional input
pr-number, to build a PR's head from an event
other thanpull_request. Unused underpull_request. - ios-ci: an optional
ui-screenshotsjob, turned on by the new
ui-screenshots-schemeandui-screenshots-pathinputs (with optional
ui-screenshots-targetandui-screenshots-destination). Under
pull_requestit runs the UI test classes the PR adds or changes, plus any
test named in a<!-- ui-screenshots: … -->marker in the PR description,
on a simulator. It pushes the screenshots they attach to an orphan
ui-screenshotsbranch and comments them on the PR, in a captioned table
per test. A caller that turns
it on must grantcontents: write. Callers that leave it off are
unaffected. - ios-ci, ota-refresh: the install-link comment also says when the
build itself is deleted, as read from the staging bucket's lifecycle rule
(head-objecton the build'smetadata.json). The line is left out when no
rule applies. Shared through the newbuild-expirycomposite action. No
caller change. - ios-ci: after the Stage job posts its install link, hide the PR's stale
comments the same way ota-refresh does. Both workflows share this through the
newstale-commentscomposite action. No caller change.
Fixed
- ota-refresh: decide that a build exists by its
metadata.json, not by
itsrun-*prefix. A refresh uploadsmanifest.plistandinstall.html
again, so after an earlier refresh the prefix outlives the build, and the
refresh failed insideota-publishinstead of explaining the missing build. - ios-ci: trust the
armcknight/toolstap beforebrew bundle, which
Homebrew now refuses to load from an untrusted tap. A caller'sBrewfile
must install the tools as a cask,cask 'armcknight/tools/tools': the tap no
longer has a formula of that name.
2.1.0
Added
-
github-release: a new reusable workflow that publishes a GitHub release
from the tagged changelog section, optionally attaching files. For repos with
nothing to build, sign or upload, where tagging is the release — a SwiftPM
library resolved from the tag, or a Spoon repo installed off the branch.
armcknight/swift-armcknightandarmcknight/hammerspoonshad each grown a
near-identical copy of this; both now call it.Every input is optional:
changelog,assets,prerelease,runs-on. A tag
with a prerelease suffix is marked a prerelease regardless of the input. The
workflow runs no caller-supplied commands — a caller gating the release on a
check puts it in its own job and depends on it withneeds:.
2.0.0
Added
-
swiftpm-cask-release: a
bundle-idinput, passed tofastlane matchas
app_identifier. match requires it even for adeveloper_idfetch with
skip_provisioning_profiles— without it signing aborted with "No value found
for 'app_identifier'". It is unused for the team-wide Developer ID certificate,
but the caller supplies its own value so the workflow carries no identity.Caller migration
Only callers that set
sign: true: add abundle-idinput (e.g.
bundle-id: com.example.<tool>).
1.2.0
Added
- swift-package-ci and swiftpm-cask-release: a
submodulesinput,
passed straight toactions/checkout. A package whose dependencies are
vendored as git submodules (path-based SwiftPM deps) setssubmodules: recursiveso the build can see them; the default (empty) is unchanged, so
existing callers are unaffected.