Versioning & change log

Create change log and versioning on github

What is change log and versioning?

Changelog

• A change log is a log or record of all notable changes made to a project.

Versioning

• Versioning is the creation and management of multiple product releases, all of which have the same general function, but are improved, upgraded or customized.

How to create change log and versioning on github?

To create a change log and versioning on github you have to follow 6 steps:

Step 1. On github project repository create release.yml file under folder .github/release.yml as you can see in below image.

release.yml file

Step 2. In release.yml file write some categories with title and labels for example for bug fixing I gave title Bug 🐞 and labels are those labels which we give to each PR from labels list on PR and they can be one or more

Example of release.yml file:

# .github/release.yml

changelog:
  categories:
    - title: Bug fixing 🐞
      labels:
        - bug
        - fixing
    - title: New Features 🎉
      labels:
        - enhancement
    - title: Improvement
      labels:
        - improvement
    - title: Documents 📚
      labels:
        - documentation

Step 3. Once done push your changes under a separate branch and create a pull request to main branch with any above label for me i am adding new feature so i will label that PR as enhancement.

PR with label

Step 4. Once PR is merged to main got to create a new release (Release is below About) on main branch of project repository

Release

Step 5. Then create a new tag and write release title and click on generate release notes and it will create release notes automatically based on your labels.

Step 6. Once everything is done you can publish release by clicking Publish release.

Release with versioning

Youtube link