Skip to content

module deprecation#1942

Merged
jtracey93 merged 28 commits into
mainfrom
feat/matebarabas/module-deprecation
Jun 4, 2025
Merged

module deprecation#1942
jtracey93 merged 28 commits into
mainfrom
feat/matebarabas/module-deprecation

Conversation

@matebarabas

@matebarabas matebarabas commented Apr 2, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Overview/Summary

This PR makes module deprecation possible.

This PR fixes/adds/changes/removes

  1. New issue template for deprecation request
  2. Update documentation to describe lifecycle stage
  3. New GitHub label
  4. Update shortcodes to reflect deprecated state on the module index pages
  5. Add guidance on what disclaimers the README file should contain and what the ARCHIVED.md file should contain
  6. Update the logic of all short codes to not include emojis in the moduleStatus column of the module index CSVs
  7. Change moduleStatus emojis to traffic lights

Related changes:

  1. (Bicep) Update script to not show deprecated modules in IntelliSense BRM#5265
  2. (Bicep) Update script to generate README file content based on the presence and content of DEPRECATED.md
  3. (Bicep) Update logic to not list deprecated modules in issue templates --> no change needed, the current logic supports the addition of the new deprecated state.

This PR must be merged at the same time Azure/bicep-registry-modules#5353 is merged.

Breaking Changes

  1. n/a

As part of this Pull Request I have

  • Read the Contribution Guide and ensured this PR is compliant with the guide
  • Checked for duplicate Pull Requests
  • Associated it with relevant GitHub Issues or ADO Work Items (Internal Only)
  • Ensured my code/branch is up-to-date with the latest changes in the main branch
  • Ensured PR tests are passing
  • Updated relevant and associated documentation (e.g. Contribution Guide, Docs etc.)

@microsoft-github-policy-service microsoft-github-policy-service Bot added the Needs: Triage 🔍 Maintainers need to triage still label Apr 2, 2025
@matebarabas matebarabas self-assigned this May 1, 2025
@matebarabas matebarabas added Type: Documentation 📄 Improvements or additions to documentation Type: Hygiene 🧹 things related to testing, issue triage etc. and removed Needs: Triage 🔍 Maintainers need to triage still labels May 1, 2025
@ReneHezser

ReneHezser commented May 30, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

The existing logic already picks up a file ORPHANED.md and includes its content into the Readme.md like this:

ORPHANED.md file content:

This modules is orphaned, as bla und blub. Please check if this and that will help you.
A second line needs to be added.

And, with an empty line separation, another line.

creates the README.md like this:

# Azure Compute Galleries `[Microsoft.Compute/galleries]`

> This modules is orphaned, as bla und blub. Please check if this and that will help you.
> A second line needs to be added.
> 
> And, with an empty line separation, another line.

This module deploys an Azure Compute Gallery (formerly known as Shared Image Gallery).

## Navigation
...

The same is now done with the content of the file DEPRECATED.md.

@matebarabas

matebarabas commented May 30, 2025

Copy link
Copy Markdown
Contributor Author

@ReneHezser, can you please point me to the PR you implemented this in? Thanks!

@ReneHezser ReneHezser mentioned this pull request Jun 2, 2025
Merged
11 tasks
ReneHezser added a commit to Azure/bicep-registry-modules that referenced this pull request Jun 3, 2025
@ReneHezser
feat: adds deprecation message to the readme (#5334)
35056c8 
## Description

Content of the file `DEPRECATED.md` is merged into the `README.md` file.

Adds to Azure/Azure-Verified-Modules#1942

## Pipeline Reference

| Pipeline |
| -------- |
|
[![avm.res.compute.gallery](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.gallery.yml/badge.svg?branch=deprecation-test)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.gallery.yml)
|

The pipeline ran with an existing deprecation file. The module-specific
files for this test have been removed again.

## Type of Change

- [x] Update to CI Environment or utilities (Non-module affecting
changes)
- [ ] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [ ] My corresponding pipelines / checks run clean and green without
any errors or warnings
@ReneHezser

ReneHezser commented Jun 3, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

feat: Enhance module index generation script to exclude deprecated modules has been merged

@matebarabas matebarabas marked this pull request as ready for review June 4, 2025 15:58
@matebarabas matebarabas requested a review from a team as a code owner June 4, 2025 15:58
@matebarabas matebarabas mentioned this pull request Jun 4, 2025
Merged
11 tasks
@jtracey93 jtracey93 merged commit 9b88e95 into main Jun 4, 2025
7 checks passed
@jtracey93 jtracey93 deleted the feat/matebarabas/module-deprecation branch June 4, 2025 17:12
jtracey93 pushed a commit to Azure/bicep-registry-modules that referenced this pull request Jun 4, 2025
@matebarabas
fix: update scripts to not include emojis in status filters (#5353)
a9eb7b0 
## Description

Previously the module index CSVs included emojis in their moduleStatus
column, e.g., "Available 🟢" These emojis are now being removed by [this
PR](Azure/Azure-Verified-Modules#1942). As a
result, all scripts relying on the presence of the emojis need to be
updated.

This PR updates scripts to not include emojis in status filters.

This PR must be merged at the same time as
[Azure/Azure-Verified-Modules#1942](Azure/Azure-Verified-Modules#1942)
is merged.

**ALL PIPELINES MUST BE DISABLED BEFORE MERGING THIS PR!**


## Type of Change

- [x] Update to CI Environment or utilities (Non-module affecting
changes)
- [ ] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [ ] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [ ] My corresponding pipelines / checks run clean and green without
any errors or warnings
yffok pushed a commit to yffok/bicep-registry-modules that referenced this pull request Jan 15, 2026
@ReneHezser @yffok
feat: adds deprecation message to the readme (Azure#5334)
13234ba 
## Description

Content of the file `DEPRECATED.md` is merged into the `README.md` file.

Adds to Azure/Azure-Verified-Modules#1942

## Pipeline Reference

| Pipeline |
| -------- |
|
[![avm.res.compute.gallery](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.gallery.yml/badge.svg?branch=deprecation-test)](https://github.com/ReneHezser/bicep-registry-modules/actions/workflows/avm.res.compute.gallery.yml)
|

The pipeline ran with an existing deprecation file. The module-specific
files for this test have been removed again.

## Type of Change

- [x] Update to CI Environment or utilities (Non-module affecting
changes)
- [ ] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [x] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [ ] My corresponding pipelines / checks run clean and green without
any errors or warnings
yffok pushed a commit to yffok/bicep-registry-modules that referenced this pull request Jan 15, 2026
@matebarabas @yffok
fix: update scripts to not include emojis in status filters (Azure#5353)
13544c1 
## Description

Previously the module index CSVs included emojis in their moduleStatus
column, e.g., "Available 🟢" These emojis are now being removed by [this
PR](Azure/Azure-Verified-Modules#1942). As a
result, all scripts relying on the presence of the emojis need to be
updated.

This PR updates scripts to not include emojis in status filters.

This PR must be merged at the same time as
[Azure/Azure-Verified-Modules#1942](Azure/Azure-Verified-Modules#1942)
is merged.

**ALL PIPELINES MUST BE DISABLED BEFORE MERGING THIS PR!**


## Type of Change

- [x] Update to CI Environment or utilities (Non-module affecting
changes)
- [ ] Azure Verified Module updates:
- [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT
bumped the MAJOR or MINOR version in `version.json`:
- [ ] Someone has opened a bug report issue, and I have included "Closes
#{bug_report_issue_number}" in the PR description.
- [ ] The bug was found by the module author, and no one has opened an
issue to report it yet.
- [ ] Feature update backwards compatible feature updates, and I have
bumped the MINOR version in `version.json`.
- [ ] Breaking changes and I have bumped the MAJOR version in
`version.json`.
  - [ ] Update to documentation

## Checklist

- [x] I'm sure there are no other open Pull Requests for the same
update/change
- [ ] I have run `Set-AVMModule` locally to generate the supporting
module files.
- [ ] My corresponding pipelines / checks run clean and green without
any errors or warnings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jtracey93 jtracey93 jtracey93 approved these changes

Assignees

@matebarabas matebarabas

Labels

Type: Documentation 📄 Improvements or additions to documentation Type: Hygiene 🧹 things related to testing, issue triage etc.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@matebarabas @ReneHezser @jtracey93