AZDO: Update Changelog

2 minute read

Description:

So a Changelog is a common software practice where developers will note any changes between git tags in a repo. Here is how I’m implementing changelogs for my module repos:

To Resolve:

  1. So first, just create a ./docs/changelog.md in your repo and follow a pattern like this:

    • Note: In this example, I will add some notes between version v0.0.2 and v0.0.3

    • So as of v0.0.2, it looks like this:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

    # Changelog

All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://my-org@dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GBmain&targetVersion=GTv0.0.2&_a=commits)

## [v0.0.2](https://my-org@dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GTv0.0.2&targetVersion=GTv0.0.1&_a=commits) - 2023-01-11

### Added
- Updated terragrunt

### Changed

### Removed

### Fixed

## [v0.0.1](https://dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GBmain&targetVersion=GTv0.0.1&_a=commits)

### Added

- Initialized repo

### Changed

### Removed

### Fixed

    • So reading this, we can see the initial version v0.0.1 initialized the repo and v0.0.2 updated terragrunt. Not very descriptive, but a basic example.

    • So now lets add some notes before bumping our repo to v0.0.3:

    • First, add a line break before the ## [v0.0.2] line but after the ## [Unreleased] line

    • Then copy/paste these 4 blocks

    1
2
3
4
5
6
7
8

    ### Added

### Changed

### Removed

### Fixed

    • Now, add whatever comments by typing - comment replacing `comment with human readable updates between your last git tag and the one you are about to bump to.

    • Here I will add - Test comment so it now looks like this:

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

    # Changelog

All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://my-org@dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GBmain&targetVersion=GTv0.0.2&_a=commits)

### Added

### Changed
- Test comment

### Removed

### Fixed

## [v0.0.2](https://my-org@dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GTv0.0.2&targetVersion=GTv0.0.1&_a=commits) - 2023-01-11

### Added
- Updated terragrunt

### Changed

### Removed

### Fixed

## [v0.0.1](https://dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GBmain&targetVersion=GTv0.0.1&_a=commits)

### Added

- Initialized repo

### Changed

### Removed

### Fixed

  2. Now commit your changes and run your bump version pipeline

  3. Lastly, do a pull in your repo since the bump version pipeline pushes. It should now look like this

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

    # Changelog

All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased](https://my-org@dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GBmain&targetVersion=GTv0.0.3&_a=commits)

## [v0.0.3](https://my-org@dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GTv0.0.3&targetVersion=GTv0.0.2&_a=commits) - 2023-01-11

### Added

### Changed
- Test comment

### Removed

### Fixed

## [v0.0.2](https://my-org@dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GTv0.0.2&targetVersion=GTv0.0.1&_a=commits) - 2023-01-11

### Added
- Updated terragrunt

### Changed

### Removed

### Fixed

## [v0.0.1](https://dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GBmain&targetVersion=GTv0.0.1&_a=commits)

### Added

- Initialized repo

### Changed

### Removed

### Fixed

    • See how it added the line for you? ## [v0.0.3](https://my-org@dev.azure.com/my-project/_git/my-repo/branchCompare?baseVersion=GTv0.0.3&targetVersion=GTv0.0.2&_a=commits) - 2023-01-11 ?

    • That’s it!

Comments

You May Also Enjoy