#5 Update and complete README
Merged 4 years ago by pingou. Opened 4 years ago by nphilipp.
fedora-infra/ nphilipp/generate_changelog master--README  into  master

file modified
+38 -6
@@ -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 @@ 

  

    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 @@ 

      --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

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

Signed-off-by: Nils Philippsen nils@redhat.com

Pull-Request has been merged by pingou

4 years ago
Metadata