Skip to content

docs: add deprecation notice to README#801

Open
kddejong wants to merge 1 commit into
aws-cloudformation:mainfrom
kddejong:readme/deprecation-notice
Open

docs: add deprecation notice to README#801
kddejong wants to merge 1 commit into
aws-cloudformation:mainfrom
kddejong:readme/deprecation-notice

Conversation

@kddejong

@kddejong kddejong commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Rain is no longer actively maintained and will be archived shortly after this change merges. This PR adds a prominent deprecation notice to the top of the README so users are informed before they invest in adopting the tool.

Changes

  • Add a > [!WARNING] deprecation callout at the top of README.md, covering:
    • Rain is deprecated / no longer actively maintained
    • Issues and PRs may not be reviewed or merged
    • Repo will move to an archived, read-only state
    • Existing releases remain available; no new releases or security patches
    • Recommended alternatives: AWS CLI, AWS CDK (for reusable components such as modules), cfn-lint, cfn-guard
  • Mirror the same notice into docs/README.tmpl, since README.md is generated via go generate and an edit to README.md alone would be overwritten on the next regeneration.

Notes

The repository is expected to be archived within a day or two of this merging.

Rain is no longer actively maintained and will be archived shortly after
this change merges. Add a prominent deprecation warning to the top of the
README (and its source template docs/README.tmpl so the notice survives
`go generate`), pointing users to actively supported alternatives: the
AWS CLI, AWS CDK (for reusable components such as modules), cfn-lint, and
cfn-guard.
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.

4 participants