Skip to content

docs: add notes of v1.2.0 - #81

Merged
uniqueg merged 2 commits into
mainfrom
docs/v1.2.0-notes
Nov 15, 2026
Merged

uniqueg merged 2 commits into
mainfrom
docs/v1.2.0-notes

Conversation

@uniqueg

@uniqueg uniqueg commented Nov 15, 2026 •

Copy link
Copy Markdown
Member

Summary

Adds the curated release notes of v1.2.0 (docs/releases/v1.2.0.md), as RELEASING.md asks before the tag: release assets in publish-release (#77, #79), the pip check in scan-image (#55, #74), the gate cancel fix (#72, #71), and maintenance (#75, #76, #64).

Closes #80

Verification

  • bash .github/scripts/release.sh lint v1.2.0 docs/releases/v1.2.0.md: passes.
  • CI: all checks passed (CI passed, Lint, Test, CodeQL).

Declined review findings

  • Sourcery: notes could miss changes merged between this PR and the tag. The tag goes on this PR's merge commit by SHA, so later merges aren't in v1.2.0.

Light lane: docs only (one new release notes file); reviewed the diff myself.

🤖 Generated with Claude Code

Add the curated release notes of v1.2.0: release assets in
publish-release, pip check in scan-image, and the gate cancel fix.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@uniqueg uniqueg added the type: docs Improvements or additions to documentation label Nov 15, 2026
@uniqueg uniqueg self-assigned this Nov 15, 2026
@sourcery-ai

sourcery-ai Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

Documentation

Add curated v1.2.0 release notes covering action changes, gate concurrency guidance, and maintenance updates.

  • docs/releases/v1.2.0.md L1-29

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@uniqueg
uniqueg marked this pull request as ready for review November 15, 2026 21:51
@sourcery-ai

sourcery-ai Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Linked issues

Checked at commit 8a72587

#80 docs: add notes of v1.2.0 · 5 of 6 met · 1 to check by hand

# Requirement Status Notes
1 Add curated notes at docs/releases/v1.2.0.md. ✅ Met
2 Document publish-release assets, including immutable releases. ✅ Met
3 Document scan-image failing scans for images that contain pip. ✅ Met The notes explain that fail-on-pip is opt-in and defaults to false.
4 Document gate cancelling PR runs only for new commits. ✅ Met The notes describe the concurrency settings callers adopt and clarify that the action itself is unchanged.
5 Have the notes on main before the tag. 👀 Check by hand (external system) Confirm this PR is merged to main before creating the v1.2.0 tag.
6 Pass release.sh lint v1.2.0. ✅ Met The notes follow the linter's required title, intro, section order, and completed-content checks; the PR description also reports the lint command passes.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've found 4 issues

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="docs/releases/v1.2.0.md" line_range="6" />
<code_context>
+Release v1.2.0 of the shared actions of ELIXIR On-Cloud adds the input
+`assets` to the action `publish-release`, which attaches files (e.g., a
+packaged Helm chart) to the GitHub release, also in repositories with
+immutable releases. The action `scan-image` now fails scans of images that
+contain pip, and the action `gate` cancels pull request runs only for new
+commits. The action `pr-title` is unchanged. Callers pin
</code_context>
<issue_to_address>
**Pip images still pass**

When callers update the pin without setting `fail-on-pip` to `true`, `scan-image` defaults `fail-on-pip` to `false`, so its pip check does not reject images containing pip and those scans pass despite the release note.

Clarify in the release notes that rejecting images containing pip requires callers to enable `fail-on-pip`.

Also at `docs/releases/v1.2.0.md:8`, `docs/releases/v1.2.0.md:15`.
</issue_to_address>

### Comment 2
<location path="docs/releases/v1.2.0.md" line_range="7" />
<code_context>
+`assets` to the action `publish-release`, which attaches files (e.g., a
+packaged Helm chart) to the GitHub release, also in repositories with
+immutable releases. The action `scan-image` now fails scans of images that
+contain pip, and the action `gate` cancels pull request runs only for new
+commits. The action `pr-title` is unchanged. Callers pin
+`elixir-cloud-aai/.github/actions/<name>@<commit> # v1.2.0`; Dependabot
</code_context>
<issue_to_address>
**Pinned gate leaves runs uncanceled**

When callers update the `gate` pin without changing their workflow concurrency settings, the `gate` action only checks job results; caller workflow concurrency settings control cancellation, so updating the pin alone does not make runs cancel only for new commits.

Clarify in the release notes that callers must configure workflow-level concurrency to get the cancellation behavior.

Also at `docs/releases/v1.2.0.md:19`.
</issue_to_address>

### Comment 3
<location path="docs/releases/v1.2.0.md" line_range="3-7" />
<code_context>
+# v1.2.0
+
+Release v1.2.0 of the shared actions of ELIXIR On-Cloud adds the input
+`assets` to the action `publish-release`, which attaches files (e.g., a
+packaged Helm chart) to the GitHub release, also in repositories with
+immutable releases. The action `scan-image` now fails scans of images that
+contain pip, and the action `gate` cancels pull request runs only for new
+commits. The action `pr-title` is unchanged. Callers pin
+`elixir-cloud-aai/.github/actions/<name>@<commit> # v1.2.0`; Dependabot
</code_context>
<issue_to_address>
**Concurrent changes go undocumented**

When an action PR merges to `main` after this notes file is merged but before the release tag is created, `release.sh check` validates the version and tagged commit, but not whether these notes cover every change on that commit. If another action PR merges after the notes PR and before the maintainer tags `main`, the release workflow publishes that change with this notes file, so callers see an undocumented change.

Before tagging, reconcile the notes against the exact commit to be released, or prevent other changes from entering that release commit.
</issue_to_address>

### Comment 4
<location path="docs/releases/v1.2.0.md" line_range="8-9" />
<code_context>
+packaged Helm chart) to the GitHub release, also in repositories with
+immutable releases. The action `scan-image` now fails scans of images that
+contain pip, and the action `gate` cancels pull request runs only for new
+commits. The action `pr-title` is unchanged. Callers pin
+`elixir-cloud-aai/.github/actions/<name>@<commit> # v1.2.0`; Dependabot
+proposes the update.
+
</code_context>
<issue_to_address>
**Gate pin leaves cancellation unchanged**

Also at `docs/releases/v1.2.0.md:19`.
</issue_to_address>

Sourcery assessment

Approval pending. 4 findings to address first.

Blocking findings: docs/releases/v1.2.0.md:6, docs/releases/v1.2.0.md:7, docs/releases/v1.2.0.md:7, docs/releases/v1.2.0.md:9


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

Comment thread docs/releases/v1.2.0.md Resolved
Comment thread docs/releases/v1.2.0.md Resolved
Comment thread docs/releases/v1.2.0.md Resolved
Comment thread docs/releases/v1.2.0.md Resolved
State that fail-on-pip defaults to false and that the gate fix is
documented concurrency settings callers adopt, not an action change.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@uniqueg
uniqueg merged commit bf3840c into main Nov 15, 2026
7 checks passed
@uniqueg
uniqueg deleted the docs/v1.2.0-notes branch November 15, 2026 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add notes of v1.2.0

1 participant