Skip to content

docs: clarify changelog fragment workflow - #32046

Open
vyncint wants to merge 3 commits into
hashicorp:mainfrom
vyncint:docs/changelog-workflow-32030
Open

docs: clarify changelog fragment workflow#32046
vyncint wants to merge 3 commits into
hashicorp:mainfrom
vyncint:docs/changelog-workflow-32030

Conversation

@vyncint

@vyncint vyncint commented Jul 22, 2026

Copy link
Copy Markdown

Description

Clarifies the relationship between changelog fragments and the root CHANGELOG.md for contributors. This change documents:

  • when a changelog fragment is expected and when pr/no-changelog is appropriate;
  • how to add a PR-numbered fragment after opening a pull request;
  • how release tooling collects fragments and generates PR links;
  • the complete set of documented changelog categories; and
  • a changelog checkpoint in the pull request template.

Closes #32030.

Changelog

  • This change only updates repository contributor documentation, so it does not need a changelog fragment. Please apply the pr/no-changelog label.

Testing

  • git diff HEAD^ --check
  • Verified the documented filename and label behavior against .github/workflows/changelog-checker.yml.

PCI review checklist

  • I have documented a clear reason for, and description of, the change I am making.
  • Not applicable: this documentation-only change does not alter security controls.
  • Not applicable: this documentation-only change does not require a special revert plan.

Copilot AI review requested due to automatic review settings July 22, 2026 06:04
@vyncint
vyncint requested review from a team as code owners July 22, 2026 06:04
@vyncint
vyncint requested review from hashigator and ryancragun July 22, 2026 06:04
@vercel

vercel Bot commented Jul 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
vault-ui Error Error Jul 23, 2026 11:57pm

Request Review

@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jul 22, 2026
@vercel

vercel Bot commented Jul 22, 2026

Copy link
Copy Markdown

Deployment failed with the following error:

The `vercel.json` schema validation failed with the following message: should NOT have additional property `public`

Learn More: https://vercel.com/docs/concepts/projects/project-configuration

@dosubot dosubot Bot added the docs label Jul 22, 2026
@hashicorp-cla-app

hashicorp-cla-app Bot commented Jul 22, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@hashicorp-cla-app

Copy link
Copy Markdown

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

Have you signed the CLA already but the status is still pending? Recheck it.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR clarifies the contributor-facing workflow for changelog fragments and how those fragments relate to the root CHANGELOG.md, including when pr/no-changelog is appropriate and adding a changelog checkpoint to the PR template.

Changes:

  • Expanded CONTRIBUTING.md guidance on when to add a changelog fragment, expected categories, and why CHANGELOG.md should not be edited directly.
  • Added contributor-focused workflow documentation to changelog/README.md, including notes about fragment collection into CHANGELOG.md.
  • Updated the PR template to include a changelog checklist item and a pointer to the changelog guidance.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
CONTRIBUTING.md Documents when/why to add changelog fragments, categories, and how fragments feed CHANGELOG.md.
changelog/README.md Adds a “Contributor workflow” section explaining fragment expectations and release aggregation.
.github/pull_request_template.md Adds a changelog checklist item linking to the contributor guidance.

Comment thread CONTRIBUTING.md Outdated
Comment thread changelog/README.md Outdated
Comment thread .github/pull_request_template.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify changelog fragment workflow for contributors

2 participants