Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mahendrapaipuri/gitlab-activity
A simple command line utility to generate Changelogs for GitLab repositories
https://github.com/mahendrapaipuri/gitlab-activity
Last synced: 21 days ago
JSON representation
A simple command line utility to generate Changelogs for GitLab repositories
- Host: GitHub
- URL: https://github.com/mahendrapaipuri/gitlab-activity
- Owner: mahendrapaipuri
- License: bsd-3-clause
- Created: 2023-10-26T07:17:15.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-16T09:27:20.000Z (4 months ago)
- Last Synced: 2024-09-16T19:54:16.882Z (4 months ago)
- Language: Python
- Size: 609 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GitLab Changelog Generator
| | |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CI/CD | [](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/commits/main) [ ](https://codecov.io/gl/mahendrapaipuri/gitlab-activity) |
| Docs | [](https://mahendrapaipuri.gitlab.io/gitlab-activity/) |
| Package | [](https://pypi.org/project/gitlab-activity/) [](https://pypi.org/project/gitlab-activity/) |
| Meta | [](https://gitlab.com/mahendrapaipuri/gitlab-activity) [](https://github.com/astral-sh/ruff) [](https://github.com/psf/black) |
## What is it about?
Generate simple markdown changelogs for GitLab repositories. GitLab provides an
[API endpoint](https://docs.gitlab.com/ee/user/project/changelogs.html) to generate
Changelogs. However, this endpoint assumes that repository is using
[Git trailers](https://docs.gitlab.com/ee/user/project/changelogs.html) in the commit
message. If no Git trailers are found in the commit messages, the API endpoint returns nothing.
This is a huge problem for a lot of projects (including us) that do not use Git trailers.
Although it is a good practice to use Git trailers we tend to forget them and it
increases development time. Moreover we are more concerned to have MRs listed in the
changelogs and we can tag MRs with labels that identify the type of MR. We can
generate a changelog using these labels and group MRs according to the labels.
This is what this little package does to generate changelogs. In a nutshell, it does
two things:
1. Given a GitLab (upstream or self hosted) repository, an initial git reference or date,
use the [GitLab GraphQL API](https://docs.gitlab.com/ee/api/graphql/reference/index.html)
to return a DataFrame of all issue and MR activity for this time period.
2. A CLI to render this activity as markdown, suitable for generating changelogs.
## Prior art
- [gitlab-changelog-generator](https://github.com/stuartmccoll/gitlab-changelog-generator)
is a command line utility distributed as Python package to generate changelogs.
However, it is mostly outdated and I could not make it work as of 2023.
- [gitlab-changelog-generator](https://github.com/skywinder/gitlab-changelog-generator)
is another tool to generate changelogs based on Ruby. However there has been no
development since last few years.
## Features
- Users can configure the labels and their descriptions that they use in their projects
- `gitlab-activity` configuration supports `pyproject.toml` for Python projects,
`package.json` for Node projects. For other projects, configuration can be included
in a file `.gitlab-activity.toml` in the root of the repository.
- It can be integrated into CI release jobs to update the changelogs from last stable
tag to current before making the release.
:::important
This tool is heavily inspired from
[github-activity](https://github.com/executablebooks/github-activity) developed by the
folks at [Jupyter project](https://jupyter.org/). All the credit should go to them
and we thank them.
:::
## Installation
The easiest way to install this package is via `pip`:
```
pip install gitlab-activity
```
## Usage
The easiest way to use `gitlab-activity` to generate activity markdown is to use
the command-line interface. It takes the following form:
```
gitlab-activity -t [/]
```
This will output a markdown with MRs activity since last tag.
:::tip
The [Changelog](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/blob/main/CHANGELOG.md)
file of the current repository is being generated by `gitlab-activity`. Have a look
into [CI](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/blob/main/.gitlab-ci.yml)
file on how it is being done.
:::
## Configuration
All the CLI options can be configured _via_ configuration file. An example
[config](https://gitlab.com/mahendrapaipuri/gitlab-activity/-/blob/main/example-configs/.gitlab-activity.toml)
file can be used as a reference.
As stated above the configuration can be integrated into `pyproject.toml` in
`[tool.gitlab-activity]` section or `package.json` in `gitlab-activity` key.
## To run the tests
The easiest way to run the test suite is using `pytest`.
```
pytest
```