Skip to content

docs: correct the summary job's log group path - #94

Merged
hughgrigg merged 1 commit into
mainfrom
feat/name-the-summary-log-group
Aug 28, 2026
Merged

docs: correct the summary job's log group path#94
hughgrigg merged 1 commit into
mainfrom
feat/name-the-summary-log-group

Conversation

@hughgrigg

Copy link
Copy Markdown
Contributor

The "When a run fails" section sent a reader to /aws/lambda/<function>, where nothing is written. SummaryFunction passes the Function an explicit LogGroup carrying no logGroupName, and CloudFormation therefore names the group after the stack and the logical id, the way the permissions section further down already says it names the function and the roles. Somebody following the old line looked in an absent log group while a run was failing. The bullet now claims only what it can, and a paragraph under it gives the name's shape, says the /aws/lambda path holds nothing here, and points at the function's Monitor tab in the console and a describe-stack-resources query for a terminal. Naming the group conventionally was the other end to fix, and it was left alone. The log group is passed into the function, so deriving its name from the function's Ref is a CloudFormation cycle, and the physical function name that breaks the cycle would be a fourth name needing to be unique per account, beside schedulePrefix, workgroupName and databaseName. Documentation only, and no construct changes.

pnpm check fails on main at src/cdk/rollup-summaries.test.ts:539, where viewsOnly is undefined and two tests throw on it. That arrived with #91 and is unrelated to this branch. The box below is unticked for it, and every other step of the check passes here.

@coderabbitai ignore

  • Conventional commit message, used as the title

  • Conventional branch name, like feat/concise-description

  • Full check with pnpm run check passed

  • Rebased off latest main

  • User-facing behaviour is documented in docs/

See https://www.conventionalcommits.org/en/v1.0.0/

The "When a run fails" section sent a reader to /aws/lambda/<function>,
where nothing is written. SummaryFunction passes the Function an explicit
LogGroup carrying no logGroupName, and CloudFormation therefore names the
group after the stack and the logical id, the way the permissions section
below already says it names the function and the roles.

The bullet now claims only what it can, and a paragraph under it gives the
name's shape, says the /aws/lambda path holds nothing here, and points at
the console's Monitor tab and a describe-stack-resources query.
@hughgrigg
hughgrigg merged commit 6c2683e into main Aug 28, 2026
7 checks passed
@hughgrigg
hughgrigg deleted the feat/name-the-summary-log-group branch August 28, 2026 19:30
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.

1 participant