Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ You can see the published documentation at https://terraform-ibm-modules.github.
- [Metadata file (index.yml)](https://terraform-ibm-modules.github.io/documentation/#/module-catalog-metadata.md)
- [About module badges](https://terraform-ibm-modules.github.io/documentation/#/badge-status.md)
- [Release versioning](https://terraform-ibm-modules.github.io/documentation/#/versioning.md)
- [Deprecation policy](https://terraform-ibm-modules.github.io/documentation/#/deprecation.md)
- Governance
- DA consumer tips
- [Prefix](https://terraform-ibm-modules.github.io/documentation/#/prefix.md)
Expand Down
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [Metadata file (index.yml)](module-catalog-metadata.md)
- [About module badges](badge-status.md)
- [Release versioning](versioning.md)
- [Deprecation policy](deprecation.md)
- Governance
- DA consumer tips
- [Prefix](prefix.md)
Expand Down
15 changes: 15 additions & 0 deletions docs/deprecation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Deprecation Policy

A module may be deprecated for several reasons. For example, there might be a newer module available for migration, or one of the IBM Cloud services that the module provisions might have reached its end of life. The following sections describe the phases of the deprecation process:

## Initial Deprecation (90 Days)
A new patch version of the module will be released with the following updates:

- A **deprecation banner** added to the top of the `README.md` file, including the end-of-support date (90 days after the patch release). The banner will also provide details on why the module is deprecated and may include links to alternative modules or migration guides.
- A **warning message** added to the Terraform log output with deprecation details.

During this phase, the module remains maintained and supported; however, no new enhancements will be accepted.

## End of Support – Module Archived

After the 90-day deprecation period, the module will be archived and no longer maintained. Previous versions will remain available for consumption, but there will be no further support or updates. The repository will be archived in a read-only state.