docs: correct the summary job's log group path - #94
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The "When a run fails" section sent a reader to
/aws/lambda/<function>, where nothing is written.SummaryFunctionpasses theFunctionan explicitLogGroupcarrying nologGroupName, 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/lambdapath holds nothing here, and points at the function's Monitor tab in the console and adescribe-stack-resourcesquery 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'sRefis a CloudFormation cycle, and the physical function name that breaks the cycle would be a fourth name needing to be unique per account, besideschedulePrefix,workgroupNameanddatabaseName. Documentation only, and no construct changes.pnpm checkfails onmainatsrc/cdk/rollup-summaries.test.ts:539, whereviewsOnlyis 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-descriptionFull check with
pnpm run checkpassedRebased off latest main
User-facing behaviour is documented in
docs/See https://www.conventionalcommits.org/en/v1.0.0/