docs: document summary bucket output

[hughgrigg]

Documents how an application can expose the CloudFormation-generated summary bucket name with a CfnOutput, write it to local JSON with cdk deploy --outputs-file, and load RAINLYTICS_SUMMARY_BUCKET without adding runtime CloudFormation permissions. It also records the retention, replacement, and rollback tradeoffs of summariesBucketName. The coverage stage of pnpm check fails in unchanged Yulin-backed tests: 701 tests pass and 81 fail across 9 files; formatting, lint, docs, FTA, build, package, and size checks pass.

• 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/

Summary by CodeRabbit

• Documentation
  • Added guidance for configuring the generated summaries bucket name with RAINLYTICS_SUMMARY_BUCKET.
  • Documented how to retrieve the bucket name after deployment or from an outputs file.
  • Clarified that CLI summary reads require only s3:GetObject and do not perform per-run CloudFormation lookups.
  • Documented the summariesBucketName option, including replacement and retention behavior.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: dda250cb-1fa0-420c-94bd-c9b1c72f9996

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 8fca222d-f24e-48d3-99cd-9b623d374947

📥 Commits

Reviewing files that changed from the base of the PR and between dc52255 and ea7dd14.

📒 Files selected for processing (2)

• docs/command-line/README.md
• docs/summary-schedule/README.md

Included review availability: 1 review is currently available. Your included PR review attempts over the past 7 days set your current allowance at 2 reviews per hour.

---

📝 Walkthrough

Walkthrough

The documentation now explains how to publish the generated summaries bucket name through CloudFormation, retrieve it from CDK outputs, configure RAINLYTICS_SUMMARY_BUCKET, and document the summariesBucketName property.

Changes

Summary bucket configuration

Layer / File(s)	Summary
Bucket output and CLI configuration docs/summary-schedule/README.md, docs/command-line/README.md	Documents CloudFormation output and CDK output-file configuration for the generated bucket name. Documents RAINLYTICS_SUMMARY_BUCKET, summariesBucketName, bucket replacement and retention behavior, and the CLI’s continued s3:GetObject requirement without runtime CloudFormation lookups.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to ea7dd

This PR only documents how to expose and consume the summary bucket name; it does not change product behavior or runtime permissions. No actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: documenting the summary bucket output.
Description check	✅ Passed	The description explains the documentation changes and records the check results. All template items are addressed, including the failed coverage check.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/docs/summary-bucket-output

---

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