Skip to content

chore(ci): swap release-please path to step-security fork on node 24 - #41

Merged
nexx88 merged 1 commit into
circlefin:masterfrom
shanesavoie:chore/release-please-oss-v6-node24
Jul 1, 2026
Merged

nexx88 merged 1 commit into
circlefin:masterfrom
shanesavoie:chore/release-please-oss-v6-node24

Conversation

@shanesavoie

@shanesavoie shanesavoie commented Jul 1, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Replaces google-github-actions/release-please-action@v3.7.13 (Node 16, archived upstream) with step-security/release-please-action-oss@v6.0.2 (Node 24, StepSecurity-maintained fork of release-please-oss v6.0.2) in the release: job of conventional-commit-release.yaml. Eliminates the last Node 16 runtime dependency in this workflow.

Why

Every downstream call to this reusable workflow emits a "Node 20 is being deprecated" warning today because GitHub is force-upgrading the release-please-action's Node 16 runtime to Node 24 during the deprecation grace period. Once GitHub retires the auto-upgrade path (see https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/), those runs will fail hard.

Example downstream run: https://github.com/circlefin/circle-ooak/actions/runs/28517949604 — the log shows Node 16 → 24 auto-forcing on this workflow.

Why this specific action

step-security/release-please-action-oss@v6.0.2 is a security-maintained direct fork of release-please-oss/release-please-action@v6.0.2:

  • same v6.0.2 tag, same JS source
  • comm diff of action.yml inputs → zero drift (including config-overrides-json, the input needed to preserve v3-era inline calls)
  • Node 24 runtime
  • covered by the org-wide step-security/* wildcard allowlist in the StepSecurity actions policy — no allowlist PR needed

What changes for callers

Zero workflow-input changes. Every v3 inline action input (changelog-types, include-v-in-tag, pull-request-title-pattern, extra-files, package-name) is preserved as a reusable-workflow input and translated into a single config-overrides-json JSON string built in a new build-config-overrides step. The four downstream callers (circle-nodejs-sdk, buidl-wallet-contracts, terraform-provider-quicknode, circle-ooak) need no changes.

Translation table

v3 input v6 destination
default-branch target-branch (renamed in v6)
changelog-types config-overrides-json.changelog-sections
include-v-in-tag config-overrides-json.include-v-in-tag
pull-request-title-pattern config-overrides-json.pull-request-title-pattern
extra-files (string) config-overrides-json.extra-files (JSON array — normalized in-workflow with per-entry whitespace trim)
package-name config-overrides-json.package-name
release-type, token same-name v6 native inputs

release-type + config-overrides-json puts release-please in inline-config mode (Manifest.fromConfig), preserving v3 behavior without requiring callers to commit a release-please-config.json file.

Output compatibility

For a single-component (root path .) release, per-path outputs (release_created, tag_name, major, minor, pr) are emitted unprefixed at the step level via setPathOutput('.', key, val) → core.setOutput(key, val), matching the v3 shape. That preserves:

  • The job-level release_created output → workflow-level release_created output → consumer references like needs.release-please.outputs.release_created.
  • Create additional tags step's steps.release.outputs.major / .minor references.
  • Checkout Release Branch step's fromJson(steps.release.outputs.pr).headBranchName parse — pr is the first PullRequest object from release-please core, which still defines headBranchName.

Test plan

  • CI green
  • After merge, one of the four downstream callers runs release-please and produces an equivalent release PR / tag shape
  • Deprecation warning gone from downstream runs

Replaces `google-github-actions/release-please-action@v3.7.13` (node 16,
archived upstream) with `step-security/release-please-action-oss@v6.0.2`
(node 24, step-security-maintained fork of release-please-oss v6.0.2)
in the `release:` job of `conventional-commit-release.yaml`. Eliminates
the last node 16 runtime dependency in this workflow, which today
surfaces as a "node 20 is being deprecated" warning on every downstream
call because github is force-upgrading the node 16 runtime to node 24
during the deprecation grace period.

why this action:

- `step-security/release-please-action-oss@v6.0.2` is a direct fork of
  `release-please-oss/release-please-action@v6.0.2` — same v6.0.2 tag,
  same JS source, `comm` diff of `action.yml` inputs shows zero drift,
  including the `config-overrides-json` input we need.
- covered by the org-wide `step-security/*` wildcard allowlist in
  stepsecurity policy — no policy PR needed.

what changes for callers:

- zero workflow-input changes. every v3 inline action input
  (`changelog-types`, `include-v-in-tag`, `pull-request-title-pattern`,
  `extra-files`, `package-name`) is preserved as a reusable-workflow
  input and translated into a single `config-overrides-json` JSON string
  built in a new `build-config-overrides` step.
- the four downstream callers (`circle-nodejs-sdk`,
  `buidl-wallet-contracts`, `terraform-provider-quicknode`,
  `circle-ooak`) need no changes.

translation mechanics:

- `default-branch` -> `target-branch` (renamed in v6).
- `changelog-types` -> `config-overrides-json.changelog-sections`.
- `include-v-in-tag`, `pull-request-title-pattern`, `extra-files`,
  `package-name` -> same keys under `config-overrides-json`.
- `extra_files` (newline- or comma-separated string in v3) is normalized
  to a JSON array via a jq pipeline that trims per-entry whitespace and
  drops blank entries, so both v3 input shapes stay compatible.

`release-type` + `config-overrides-json` puts release-please in
inline-config mode (`Manifest.fromConfig`), preserving v3 behavior
without requiring callers to commit a `release-please-config.json`
file.

outputs unchanged. for a single-component (root path '.') release, the
per-path outputs (`release_created`, `tag_name`, `major`, `minor`,
`pr`) are emitted unprefixed at the step level via
`setPathOutput('.', key, val)` -> `core.setOutput(key, val)`, matching
the v3 output shape that the `create additional tags` and `checkout
release branch` steps consume.
@shanesavoie
shanesavoie force-pushed the chore/release-please-oss-v6-node24 branch from 43baa22 to 7723721 Compare July 1, 2026 16:27
@shanesavoie shanesavoie changed the title chore(ci): swap release-please to release-please-oss v6 (Node 24) chore(ci): swap release-please path to step-security fork on node 24 Jul 1, 2026
@shanesavoie shanesavoie closed this Jul 1, 2026
@shanesavoie shanesavoie reopened this Jul 1, 2026
@nexx88
nexx88 merged commit a0f2042 into circlefin:master Jul 1, 2026
10 of 11 checks passed
nexx88 pushed a commit that referenced this pull request Jul 1, 2026
🤖 I have created a release *beep* *boop*
---


##
[1.3.8](v1.3.7...v1.3.8)
(2026-07-01)


### Miscellaneous Chores

* **ci:** swap release-please path to step-security fork on node 24
([#41](#41))
([a0f2042](a0f2042))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
zepeng811 pushed a commit that referenced this pull request Nov 12, 2026
## Summary

This repository holds 4 reusable workflows. Only `pr-scan.yaml` lets the
caller select a runner. The other 3 hardcode `runs-on: ubuntu-latest`.

This PR adds a `runs-on` input to those 3 workflows:

| Workflow | Job | Before | After |
| --- | --- | --- | --- |
| `attach-release-assets.yaml` | `release_attach_assets` |
`ubuntu-latest` | `${{ inputs.runs-on }}` |
| `actions-lint.yaml` | `lint_validate_actions` | `ubuntu-latest` | `${{
inputs.runs-on }}` |
| `conventional-commit-release.yaml` | `commit-lint` | `ubuntu-latest` |
`${{ inputs.runs-on }}` |
| `conventional-commit-release.yaml` | `release` | `ubuntu-latest` |
`${{ inputs.runs-on }}` |

Each new input copies the `runs-on` input that `pr-scan.yaml` already
defines. The description text, `required: false`, `type: string` and the
`ubuntu-latest` default all match that input.
`conventional-commit-release.yaml` applies one input to both of its
jobs.

`pr-scan.yaml` keeps its current content. This PR does not change it.

The default keeps the current behaviour, so no existing caller changes.

## Why this change is needed

A GitHub organization can enforce a runner policy. Such a policy can
forbid the GitHub-hosted `ubuntu-*` labels and allow only approved
runners. The policy then cancels any run that uses a forbidden label.

A policy of that kind reads every job in the caller workflow file. It
also reads the jobs of each reusable workflow that the caller starts. It
reads a job even when an `if` condition skips that job.

A hardcoded `runs-on` therefore breaks the caller in two ways:

1. The caller cannot select an approved runner for the reusable
workflow.
2. The caller loses its whole run, even when the affected job never
starts.

Point 2 is the harder one. A caller that starts
`attach-release-assets.yaml` only on a push to the default branch still
loses its pull request runs, because the policy reads the skipped job
too.

The same risk applies to `actions-lint.yaml` and
`conventional-commit-release.yaml`. This PR covers all 3 workflows
together, so no gap remains.

A caller-supplied `runs-on` also helps anyone who wants a larger runner
or a self-hosted runner for these workflows.

## Decision: this PR keeps the harden-runner step

PR #38 removes the `step-security/harden-runner` step and the `id-token:
write` permission from these workflows. That removal assumes the job
always runs on a custom runner that carries a built-in security agent.

That assumption holds only while `runs-on` stays hardcoded to such a
runner. Once `runs-on` becomes a caller input, the workflow cannot know
what the caller passes. A caller that passes `ubuntu-latest` would then
run with no runner-level agent and no workflow-level harden-runner.

I considered an `if:` condition that starts harden-runner only on a
runner without a built-in agent. I rejected that option for three
reasons:

1. The condition must match runner labels as strings. A caller may pass
a label, a runner group name, or a JSON array. A string match is
unreliable.
2. The condition must hold a list of approved labels. That list changes
over time, and this repository is public.
3. A fork of this repository has a different label set. The condition
gives the wrong result there.

This PR therefore keeps harden-runner for every runner.

Please confirm one point: the harden-runner action must support a runner
that already carries a security agent. I did not test that combination.

## Relationship to PR #38

I opened a separate PR instead of a rebase of #38. PR #38 changes the
same 4 files. Reasons:

- #38 is in a CONFLICTING state.
- The SHA pinning part of #38 is already on `master`. PR #39 and PR #41
pinned the actions to commit SHAs with version comments.
- The remaining content of #38 hardcodes one specific runner label and
removes harden-runner. This PR argues against both.
- A rebase of #38 must replace almost all of its content.

I excluded the SHA pinning from this PR, because `master` already has
it.

I did not close #38. Please decide what to do with it. I recommend that
you close it in favour of this PR.

## Open question for the repo owner: which default?

This PR uses `ubuntu-latest` as the default for all 3 inputs. That value
keeps the current behaviour and matches `pr-scan.yaml`. Please confirm
that choice or change it.

The trade-off:

- `ubuntu-latest` works for every consumer. Each consumer that needs
another runner must then pass one.
- A specific organization label is convenient for that one organization.
A consumer outside it cannot resolve the label. GitHub does not fail on
an unresolved label. The job queues until it times out.

This repository is public and has 14 forks. I could not determine if a
real external consumer exists. That answer decides the default.

## Required follow-up: the `v1` tag

A merge of this PR does not reach any consumer. Consumers use `@v1`.

The `v1` tag points to `057a20a7d108daaad3dc5e8e119cc2d53e42207c`, which
is release v1.3.5. The tags `v1`, `v1.3` and `stable` all still point to
that commit. `master` is 7 commits ahead, up to release v1.3.8.

The automatic tag move failed. The "Create additional tags" step of run
28533433898 failed with this error:

```
HttpError: Resource not accessible by integration - https://docs.github.com/rest/git/refs#create-a-reference
```

The release token appears to lack permission to write a git reference.

Two actions remain outside the scope of this PR:

1. Someone must repair the token permission for the "Create additional
tags" step.
2. Someone must move `v1`, `v1.3` and `stable` to a commit that contains
this change.

The `stable` tag matters too. The "Checkout Configs" step of
`pr-scan.yaml` checks out this repository at `ref: stable`.

I move no tag in this PR. Please tell me who owns that step.

## Testing

- I parsed all 5 workflow files with a YAML parser. Every file is valid.
- I confirmed that no job in `.github/workflows/` still hardcodes a
runner label.
- The pipeline of this repository calls the reusable workflows with no
`runs-on` value. The default keeps those calls working.
- This change does not touch PR #44 or PR #45. Those PRs change the
asset compile step of `attach-release-assets.yaml`.
- I opened this PR from a fork, because I have no write access. GitHub
therefore needs a maintainer to approve the workflow runs.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants