Skip to main content

2 posts tagged with "github"

View All Tags

Introducing Our Component Deprecation Process

Erik Osterman
Erik Osterman
Cloud Posse

We've documented our formal process for deprecating and archiving components to ensure transparency and give our community adequate notice when repositories are being sunset.

Hello SweetOps!

As part of our commitment to maintaining 300+ open source projects across Terraform modules, components, and other tooling, we occasionally need to deprecate repositories that are no longer actively maintained or have been superseded by better alternatives.

What to Expect​

We've added comprehensive documentation outlining our Deprecation and Archival Process to ensure this transition is as smooth as possible for everyone in our community.

When we deprecate a repository, here's what you can expect:

  1. GitHub Issue Created: A pinned issue with detailed explanation, timeline, and migration guidance
  2. README Warnings Added: Prominent deprecation notices at the top of documentation
  3. Blog Post Published: Announcement in our changelog/blog about the deprecation
  4. Pull Request Submitted: All changes announced via PR for community visibility
  5. Grace Period: Typically 90+ days for the community to migrate and ask questions
  6. Repository Archived: After the grace period, repos are archived (not deleted) and remain publicly accessible
  7. Blog Post Updated: Announcement updated to reflect the archival completion

Why This Matters​

This structured approach ensures that:

  • You have advance notice before any repository is archived
  • Migration paths and alternatives are clearly documented
  • Historical access to code is preserved
  • The community can provide feedback during the deprecation period

Our Commitment​

As stated in our GitHub documentation, we commit to always provide free and public access to our Open Source repositories. Even when archived, repositories remain accessible for historical reference and continued use.

Questions?

If you have questions about deprecated components or need migration assistance, reach out in the SweetOps Slack or GitHub Discussions.

Terraform Component GitHub Repository Has Moved!

Igor Rodionov
Igor Rodionov
Cloud Posse

The GitHub repository for Cloud Posse's Terraform components has migrated to a dedicated GitHub organization. All documentation remains here, but all future updates, contributions, and issue tracking for the source code should now be directed to the respective repositories in the new organization.

We're excited to announce that starting on November 12, 2024, we will begin migrating each component in the cloudposse/terraform-aws-components repository to individual repositories under a new GitHub organization. This change aims to improve the stability, maintainability, and usability of our components.

Why This Migration?​

Our goal is to make each component easier to use, contribute to, and maintain. This migration will allow us to:

  • Leverage terratest automation for better testing
  • Implement semantic versioning to clearly communicate updates and breaking changes
  • Improve PR review times and accelerate community contributions
  • Enable Dependabot automation for dependency management
  • And much more!

What to Expect Starting November 12, 2024​

Migration Timeline​

The migration will begin on November 12 and is anticipated to finish by the end of the following week.

Code Freeze​

Starting on November 12, this repository will be set to read-only mode, marking the beginning of a code freeze. No new pull requests or issues will be accepted here after that date.

New Contribution Workflow​

After the migration, all contributions should be directed to the new individual component repositories.

Updated Documentation​

To support this transition, we are updating our documentation and cloudposse-component updater.

Future Archiving​

In approximately six months, we plan to archive this repository and transfer it to the cloudposse-archives organization.

Frequently Asked Questions​

Does this affect Terraform modules?​

No, only the terraform-aws-components repository is affected. Our Terraform modules will remain where they are.

We are committed to making this transition as seamless as possible. If you have any questions or concerns, please feel free to post them in this issue. Your feedback is important to us, and we appreciate your support as we embark on this new chapter!