Changelog

Update the CHANGELOG file and commit it.

What is a CHANGELOG?

A CHANGELOG is a text file that records important changes made in software releases. It is commonly stored in the repository root as CHANGELOG.md. When preparing a new release, you document added features, fixes, and other important changes in this file.

# Changelog

## v1.1.0
- Added user profiles
- Fixed login issue

Commit the CHANGELOG update

For a new release, you add a version heading and change entries to the CHANGELOG file. Then you stage the file with git add and save it in Git history with git commit. This ensures that release notes are tracked like other project changes.

git add CHANGELOG.md
git commit -m "docs: update changelog"

Exercise Commit the CHANGELOG update

Stage the CHANGELOG.md file and create a commit with the message docs: add version 2.2.0 notes. Write the two commands in the correct order.

Show example solution

git add CHANGELOG.md
git commit -m "docs: add version 2.2.0 notes"

Test yourself

Which file is used to document changes made in a new release?
- index.php
- .gitignore
- README.md
- CHANGELOG.md
Show answer

CHANGELOG.md — CHANGELOG.md is used to keep a record of important changes between releases.
Stage the change record
```
git add ____
```
Show answer
```
git add CHANGELOG.md
```
CHANGELOG operations

CHANGELOG.md

Release notes file
## v1.2.0

Release heading
git add

Stages the file
git commit

Adds the record to history

Next lesson: Release commit

We Are Enhancing Your Experience

Cookie Preferences

Strictly Necessary Cookies

Analytical Cookies