Remove inline comments from Windows GNU MSYS2 package list

[leynos]

Summary

• remove inline comments from the MSYS2 package list so pacman no longer sees them as package names (closes MSYS2 setup fails due to improper handling of comments in pacman command #95)
• keep the guidance about optional cross linkers outside the with block to avoid polluting the install input

Testing

• make lint

---

https://chatgpt.com/codex/tasks/task_e_68ce877c63348322b4e16a71b93d5923

Summary by Sourcery

Remove inline comments from the MSYS2 package install list and relocate cross-linker guidance outside the with block

Bug Fixes:

• Remove inline comments from MSYS2 install list to prevent pacman from treating comments as package names

Enhancements:

• Move guidance about optional GCC-based aarch64 cross linkers outside the with block to keep install input clean

CI:

• Update GitHub Actions setup-windows-gnu action configuration

[coderabbitai]

Summary by CodeRabbit

• New Features

  • No user-facing changes in this release.

• Chores

  • Optimises build pipeline by running packaging steps only for Linux targets, reducing unnecessary work on other platforms.

• Documentation

  • Clarifies guidance for Windows GNU setup regarding MinGW toolchains and optional cross-linkers; streamlines comments for better readability.

Walkthrough

Summarise and gate nfpm-related steps in the Rust release action to run only for unknown-linux-gnu targets. Update the Windows GNU setup action by removing problematic inline comments from the MSYS2 package list and adding safe explanatory comments.

Changes

Cohort / File(s)	Change Summary
GitHub Actions — Rust build release \.github/actions/rust-build-release/action.yml	Add if guards if: contains(inputs.target, 'unknown-linux-gnu') to three steps: Install nfpm, Stage artifacts, and Package with nfpm. Skip these steps for non-Linux targets.
GitHub Actions — Windows GNU setup \.github/actions/setup-windows-gnu/action.yml	Remove inline comments from the pacman package list to prevent them being passed as arguments. Add explanatory comments separately under “Install MinGW toolchains”.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant Runner as GitHub Runner
    participant Action as rust-build-release Action
    participant nfpm as nfpm Steps

    Runner->>Action: Start workflow
    alt inputs.target contains "unknown-linux-gnu"
        Action->>nfpm: Install nfpm
        Action->>nfpm: Stage artifacts
        Action->>nfpm: Package with nfpm
    else Non-Linux target
        Note over Action,nfpm: Skip nfpm-related steps
    end
    Action-->>Runner: Continue remaining steps

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

Scripts now heed the target’s tune,
Linux packs with nfpm soon.
Windows sheds its chatty plight,
No more pacman’s frantic fright.
Pipelines hum in tidy rows—
Comments where the wisdom goes.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Out of Scope Changes Check	⚠️ Warning	Flag that the edit to .github/actions/rust-build-release/action.yml (adding nfpm step conditionals) is unrelated to the MSYS2 comment-handling objective in [#95], so the PR contains out-of-scope edits outside the linked issue's remit.	Move the rust-build-release change into a separate PR focused on packaging behaviour, keep this PR limited to MSYS2 comment removal and guidance relocation, and run CI to ensure both changes are test-covered after the split.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title Check	✅ Passed	Confirm the title accurately and concisely summarises the primary change: removal of inline comments from the Windows MSYS2 package list (and relocation of cross-linker guidance), so the PR purpose is clear to reviewers.
Linked Issues Check	✅ Passed	Confirm that the PR satisfies the linked issue [#95] primary coding objective by stripping inline comments from the MSYS2 package list and relocating advisory text out of the install input so pacman will not receive comment tokens; note that explicit shell-escaping changes are not present but are unnecessary given the comment removal.
Description Check	✅ Passed	State that the PR description is directly related to the changeset: it documents removal of inline comments from the MSYS2 package list, moving optional cross-linker guidance outside the with block, and notes a test step, so it is on-topic.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch codex/fix-pacman-comment-handling-in-setup-msys2

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7949bb and 963bda7.

📒 Files selected for processing (2)

• .github/actions/rust-build-release/action.yml (3 hunks)
• .github/actions/setup-windows-gnu/action.yml (1 hunks)

⏰ Context from checks skipped due to timeout of 120000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: python-tests (windows-latest)
• GitHub Check: python-tests (ubuntu-latest)
• GitHub Check: build-release (windows-latest, aarch64-pc-windows-gnu)
• GitHub Check: build-release (windows-latest, x86_64-pc-windows-gnu)
• GitHub Check: Sourcery review

🔇 Additional comments (3)

.github/actions/setup-windows-gnu/action.yml (2)

17-18: Eliminate inline pacman comments — re-run verification

Re-run a robust extraction to confirm no stray comment tokens remain inside the install: | block:

#!/usr/bin/env bash
python3 - <<'PY'
import re,sys
f = ".github/actions/setup-windows-gnu/action.yml"
try:
    lines = open(f).read().splitlines()
except Exception as e:
    print("ERROR: cannot open", f, file=sys.stderr); sys.exit(2)
start=None
for i,l in enumerate(lines):
    if re.match(r'^\s*install:\s*\|', l):
        start=i+1
        break
if start is None:
    print("install: | not found", file=sys.stderr); sys.exit(1)
found=False
for j in range(start, len(lines)):
    line = lines[j]
    if re.match(r'^[^\s]', line):
        break
    if re.match(r'^\s*(#|Optional:|//)', line):
        print(f"{j+1}: {line}")
        found=True
if not found:
    print("No inline comment tokens found in install block")
PY

---

29-36: Verify default llvm-mingw version and SHA‑256 pairing

yq is missing in the runner; install yq and re-run the verifier below, then paste the command output (OK: checksum matches or Mismatch: ...).

# Install mikefarah yq (Linux x86_64)
sudo wget -qO /usr/local/bin/yq https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 && sudo chmod +x /usr/local/bin/yq
# Or on macOS:
brew install yq

# Re-run the verification
ver=$(yq -r '.inputs."llvm-mingw-version".default' .github/actions/setup-windows-gnu/action.yml)
want=$(yq -r '.inputs."llvm-mingw-sha256".default' .github/actions/setup-windows-gnu/action.yml)
url="https://github.com/mstorsjo/llvm-mingw/releases/download/${ver}/llvm-mingw-${ver}-ucrt-x86_64.zip"
tmp="$(mktemp)"
curl -fsSL "$url" -o "$tmp"
got="$(sha256sum "$tmp" | awk '{print toupper($1)}')"
rm -f "$tmp"
test "$got" = "$(echo "$want" | tr '[:lower:]' '[:upper:]')" && echo "OK: checksum matches" || { echo "Mismatch: got $got want $want"; exit 1; }

.github/actions/rust-build-release/action.yml (1)

56-56: Gate nfpm steps by OS as well as target

Require nfpm packaging to run only on Linux runners and when the target contains 'unknown-linux-gnu'.

Apply:

-      if: contains(inputs.target, 'unknown-linux-gnu')
+      if: runner.os == 'Linux' && contains(inputs.target, 'unknown-linux-gnu')

Apply same change at .github/actions/rust-build-release/action.yml lines 66 and 115.

Re-run a repo-wide search to confirm no other unguarded nfpm invocations remain:

rg -nP '\bnfpm\b' -C2 || git grep -n 'nfpm' || grep -RIn --line-number 'nfpm' .

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updated the Windows GNU setup action by moving guidance on optional cross-linkers out of the package list and removing inline comments from the MSYS2 install block to avoid pacman parsing them as package names.

File-Level Changes

Change	Details	Files
Relocated guidance on optional cross-linkers outside the install block	Moved comment about adding extra cross-linkers above the msys2/setup-msys2 action step Rephrased note to emphasize llvm-mingw’s default clang support	.github/actions/setup-windows-gnu/action.yml
Removed inline comments from the MSYS2 package list to prevent pacman misinterpretation	Deleted commented lines under the install section that pacman could treat as packages	.github/actions/setup-windows-gnu/action.yml

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#95	Remove comments from the MSYS2 package list before passing to pacman to prevent them from being treated as package names.	✅
#95	Ensure that guidance about optional cross linkers is not included in the install input, but is still available as documentation.	✅

Possibly linked issues

• MSYS2 setup fails due to improper handling of comments in pacman command #95: The PR removes the inline comments from the MSYS2 package list in the setup-windows-gnu action, which were causing pacman to fail by misinterpreting them as package names.

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

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

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}