Skip to main content
Maintaining a clear, up-to-date changelog is essential for tracking project history and communicating updates. In this guide, you’ll learn how to automate changelog generation with Git and Azure Pipelines, then publish it directly to your Azure DevOps Wiki.

1. Quick Git Log Examples

Start by extracting commit history in chronological order:
Example output:
To include author and relative date, adjust the format string:
Sample entries:

Git Log Format Options

For a full list of placeholders, see the Git log documentation.

2. Integrating with Azure Pipelines

2.1 Generating Release Notes

If you’re already using the Generate Release Notes task in your azure-pipelines.yml, it might look like this:

2.2 Adding an Automated Changelog Task

Append a PowerShell step to generate CHANGELOG.md via git log, then copy and commit it:

3. Running the Pipeline

During execution, tasks run in sequence: job initialization, code checkout, dependency restore, build, release note generation, changelog creation, and file copying.
The image shows an Azure DevOps pipeline interface with a list of completed job tasks on the left and job details on the right. The tasks include initializing the job, checking out code, restoring dependencies, building the project, and generating release notes.
After the “Copy Changelog to Wiki Folder” step, the logs will confirm file operations:

4. Viewing the Changelog in the Wiki

After pipeline completion, navigate to your Azure DevOps Wiki to see the updated CHANGELOG.md listing all recent commits automatically.
The image shows a changelog page from an Azure DevOps wiki, listing recent updates and commits. The interface includes navigation options on the left and detailed change entries on the right.

5. Further Customization

You can enrich your automated changelog by:
  • Including build numbers or branch names in each entry
  • Linking Pull Requests or work items (%B, %D placeholders in git log)
  • Appending test results or code coverage summaries
Experiment with --pretty=format to tailor the output for your team’s workflow and documentation standards. Happy changelogging!

References

Watch Video