Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuartmccoll/gitlab-changelog-generator
📄 CHANGELOG.md generator for GitLab repositories
https://github.com/stuartmccoll/gitlab-changelog-generator
changelog changelog-generator gitlab pip pypi pypi-packages python python3
Last synced: 2 months ago
JSON representation
📄 CHANGELOG.md generator for GitLab repositories
- Host: GitHub
- URL: https://github.com/stuartmccoll/gitlab-changelog-generator
- Owner: stuartmccoll
- License: mit
- Created: 2018-06-16T11:44:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-04T07:07:07.000Z (over 4 years ago)
- Last Synced: 2024-09-30T03:05:03.025Z (3 months ago)
- Topics: changelog, changelog-generator, gitlab, pip, pypi, pypi-packages, python, python3
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 5
- Watchers: 1
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# GitLab CHANGELOG Generator
[![Build Status](https://travis-ci.org/stuartmccoll/gitlab-changelog-generator.svg?branch=master)](https://travis-ci.org/stuartmccoll/gitlab-changelog-generator) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
## Description
A simple command line utility to produce a CHANGELOG.md file from the commit differences between two GitLab project branches.
**Python 3.6** or **Python 3.7** are required to run this utility.
## Installation
This utility can be installed through [pip](https://pypi.org/project/pip/) by running the following command:
```shell
pip install gitlab-changelog-generator
```## Usage
```shell
changegen --ip localhost --group test-projects --project test-project --branches master release --version 1.1
```## Tests
Tests for this project utilise the [Pytest](https://pypi.org/project/pytest/) framework. To run the existing suite of unit tests run the following command within the root directory:
```shell
pytest
```## Notes
All Python code has been formatted by [Black](https://github.com/ambv/black), 'the uncompromising Python code formatter'.
Type checking has been provided by [Pyre](https://pyre-check.org/).
Continuous integration is handled by [Travis CI](https://travis-ci.org/).
## License
See [LICENSE.md](LICENSE.md).