Skip to content

Validate changelog and version metadata before an azd release #10090

Description

Description

We have had several releases where the release pipeline was started and, only after it had been running for a while, we noticed that the changelog or other release collateral had not been updated.

Add an early release-readiness validation step to the azd release pipeline. When the pipeline is explicitly running as a release, the step should fail fast if the repository metadata is not ready or is internally inconsistent.

This is intended to be a straightforward, focused improvement. We have broader ideas for automating the release workflow in #10089; that issue tracks those larger changes.

Validation

At minimum, the release-only check should verify that:

  • CHANGELOG.md no longer contains the release placeholder (example, ## 1.35.0-beta.1 (Unreleased)).
  • version.txt has been updated for the release.
  • Other versioned release collateral is updated and agrees on the release version.

The pipeline already sets a flag when it is run specifically for a release. Gate this validation on that flag so normal pipeline runs—including manual and PR-triggered runs—continue to work as they do today.

Expected result

A release pipeline with stale or mismatched release metadata fails early with a clear, actionable error. Non-release pipeline runs are unaffected.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions