Changelog
- Git course
- Intermediate
- Lesson 71/82
- 5 min
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 issueCommit 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"Practice 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.
Starter code
# Önce dosyayı sahnele
# Ardından commit oluşturSample solution
git add CHANGELOG.md
git commit -m "docs: add version 2.2.0 notes"Expected output
CHANGELOG.md sahnelendi. Commit oluşturuldu.
Questions and answers
Review the lesson questions together with their answers. To test yourself, solve the lesson interactively.
1 Which file is used to document changes made in a new release?
- index.php
- .gitignore
- README.md
- CHANGELOG.md Correct answer
Explanation: CHANGELOG.md is used to keep a record of important changes between releases.
2 Stage the change record
git add ____git add CHANGELOG.mdExplanation: git add is used to stage CHANGELOG.md before committing.
3 CHANGELOG operations
| Term | Meaning |
|---|---|
CHANGELOG.md |
Release notes file |
## v1.2.0 |
Release heading |
git add |
Stages the file |
git commit |
Adds the record to history |