Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Bicep changelog spec #1848

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

ReneHezser
Copy link
Contributor

Overview/Summary

Spec for Changelogs for Bicep

This PR fixes/adds/changes/removes

[feat: Changelog handling for modules9(https://github.com/Azure/bicep-registry-modules/pull/4357)

Breaking Changes

  1. each module, that is published (has a version.json), need to have a CHANGELOG.md file

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.)

@ReneHezser ReneHezser marked this pull request as ready for review February 24, 2025 10:04
@ReneHezser ReneHezser requested a review from a team as a code owner February 24, 2025 10:04
@ReneHezser ReneHezser enabled auto-merge (squash) February 24, 2025 12:09
Copy link
Contributor

@matebarabas matebarabas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ReneHezser, I've left a few comments/suggestions. Please review and incorporate them. Thanks!


{{% notice style="note" %}}

All published versions can be listed as tags in the Microsoft Container Registry (MCR) for each module [https://mcr.microsoft.com/v2/bicep/avm/(res|ptn|utl)/<namespace/modulename>/tags/list](https://mcr.microsoft.com/v2/bicep/avm/$moduleType/$moduleFolderName/tags/list)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite understand this bit. I feel like I'm lacking context. Can you elaborate on this a bit more? If it's not the best place to explain details, let's put it somewhere else, and include a link here.

@@ -0,0 +1,102 @@
---
title: BCPNRF22 - Changelog
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider something like: "Bicep Module Changelog".

@matebarabas matebarabas added Type: Documentation 📄 Improvements or additions to documentation and removed Needs: Triage 🔍 Maintainers need to triage still labels Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation 📄 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants