Skip to content

fix(ci): ignore comments after workflow with keys #2532

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
Chris0Jeky merged 2 commits into from
Sep 6, 2026
Merged

fix(ci): ignore comments after workflow with keys #2532

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8e25b9
fix(ci): ignore comments after workflow with keys
Chris0Jeky Sep 4, 2026
0d8d4c5
Merge branch 'main' into issue-2450/release-cache-comment
Chris0Jeky Sep 6, 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
35 changes: 34 additions & 1 deletion scripts/ci/release-cache-contract.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ function readSiblingWithInputs(lines, usesIndex, propertyIndent, location, viola
if (!line.structural || line.raw.trim() === '' || line.raw.trim().startsWith('#')) continue
if (line.indent < propertyIndent) break
if (line.indent === propertyIndent) {
const withMatch = /^\s*(?:with|"with"|'with')\s*:\s*(.*?)\s*$/.exec(line.raw)
const withMatch = /^\s*(?:with|"with"|'with')\s*:\s*(.*?)\s*$/.exec(stripYamlComment(line.raw))
if (withMatch) {
if (cleanScalar(withMatch[1]) !== '') {
violations.add(`${location}: with must use a block mapping, not an inline scalar or flow mapping`)
Expand Down Expand Up @@ -1082,6 +1082,39 @@ test('tagged with input values cannot satisfy the cache-dependency-path contract
)
})

test('trailing comments on with keys do not become inline inputs', () => {
const commentSources = validSyntheticClosure()
commentSources.set(
`${workflowPrefix}reusable-release-build.yml`,
commentSources.get(`${workflowPrefix}reusable-release-build.yml`).replace(
` - uses: actions/setup-node@v7
with:
cache: npm`,
` - uses: actions/setup-node@v7
with: # inputs below
cache: npm`,
),
)
assert.doesNotThrow(() => enforceReleaseCacheContract(commentSources))

const inlineSources = validSyntheticClosure()
inlineSources.set(
`${workflowPrefix}reusable-release-build.yml`,
inlineSources.get(`${workflowPrefix}reusable-release-build.yml`).replace(
` - uses: actions/setup-node@v7
with:
cache: npm`,
` - uses: actions/setup-node@v7
with: inline
cache: npm`,
),
)
assert.throws(
() => enforceReleaseCacheContract(inlineSources),
/with must use a block mapping, not an inline scalar or flow mapping/,
)
})

test('block scalars with indentation indicators are parsed before the cache-dependency-path check', () => {
for (const header of ['|2', '|2-', '|-2', '>1+']) {
const sources = validSyntheticClosure()
Expand Down
Loading