CLE-Infrastructure/generate_changelog
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update and complete README

Browse source 
Document how the script is invoked for changelogs and release fields.

Signed-off-by: Nils Philippsen <nils@redhat.com>
This commit is contained in:
Nils Philippsen 2020-02-26 11:36:24 +01:00
parent 059d133564
commit f12b1a8f6e
1 changed files with 38 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

44
README.rst
View file

@ -1,14 +1,24 @@
generate changelog
==================
Testbed for Automatically Generating RPM Release Fields and Changelogs
======================================================================
This project hosts a simple python script that tries to generate a RPM changelog
from a git repository.
This project hosts the `rpmautospec` python package and script, which attempt to automatically
calculate release numbers and generate an RPM changelog from the dist-git repository of a package
and the information available in the Koji build system.
Dependencies:
* python3
* python3-pygit2
General
-------
The script `rpmautospec.py` allows testing the various algorithms for automatic release and
changelog generation. It accepts normal CLI options, run `python rpmautospec.py --help` for more
information.
Generating a Changelog
----------------------
This is how you can use it:
@ -18,11 +28,11 @@ This is how you can use it:
fedpkg clone -a guake
* Run ``generate_changelog`` and point it to the repository cloned above
* Generating the changelog, pointing it to the repository cloned above
::
python generate_change guake
python rpmautospec.py generate-changelog guake
Note: You can also generate a good basic changelog using::
@ -32,5 +42,27 @@ Note: You can also generate a good basic changelog using::
--date="format:%a %b %d %Y"
Calculating the Next Value for the Release Field
------------------------------------------------
Calculate the next value for the RPM release field (i.e. to be used for the next build) by running
the script this way:
::
python rpmautospec.py calculate-release [--algorithm ...] <pkgname> <disttag> [<evr>]
E.g.:
::
python rpmautospec.py calculate-release bash fc31
::
python rpmautospec.py --algorithm holistic_heuristic gimp fc30
---
License: CC0