ivanch
/
ivanch.me
mirror of https://github.com/ivanch/ivanch.me.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

typos

This commit is contained in:
José Henrique 2023-05-25 22:20:17 -03:00
parent fae9e1d1d5
commit fc35e2f055
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
content/posts/automated-changelogs-gitlab.md
View File

@ -2,9 +2,10 @@
title: "Automated Changelogs Gitlab"
date: 2023-05-15T22:38:55-03:00
draft: false
summary: "Changelog automation on GitLab CI"
---
Changelogs are good, mainly if you need to keep track of what was changed on a release. But they can be a pain to write, especially if you have a lot of commits, people working on the same project, lots of tasks, and so on. A good spot to put some **automation** here.
Changelogs are good, mainly if you need to keep track of what was changed on a release. But they can be a pain to write, especially if you have a lot of commits, people working on the same project, lots of tasks, and so on. A good spot to put some **automation**.
There are a couple of ways we could make an automated changelog system, we will focus on making one that uses GitLab CI and the commit messages from the project. We will also take into consideration that *releases are made through git tags*.
@ -19,7 +20,7 @@ We will take advantage of these two commands:
## Creating a basic pipeline
Let's start by creating a basic pipeline that will run on the production release. We will use the `only` keyword to make sure it will only run on the production release.
Let's start by creating a basic pipeline that will run on the production release.
```yaml
run:
@ -53,7 +54,7 @@ We will output the changelog into a file named `changelog.txt` and then we will
## Generating the changelog
Note that we set the image to be `python:latest` on the `.generateChangelog` job, this is because we will use a Python script to generate the changelog. On the code we will set two functions: one that will return the latest tag, and another that will get the commits between the latest tag and the HEAD.
Note that we set the image to be `python:latest` on the `.generateChangelog` job, this is because we will use a Python script to generate the changelog. Inside the code we will set two functions: one that will return the latest tag, and another that will get the commits between the latest tag and the HEAD.
To call commands on the OS we will use the `subprocess` module, and to get the output from the command we will use the `communicate()` function. In case of an error, we can further add some error handling (more on this later).