From d5e23d3adeb00c483a2b8e36412e041d02b9c729 Mon Sep 17 00:00:00 2001 From: Nils Philippsen Date: Jan 15 2024 09:48:28 +0000 Subject: Point to the repo on GitHub Fixes: #314 Signed-off-by: Nils Philippsen --- diff --git a/README.md b/README.md new file mode 100644 index 0000000..61b9380 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# rpmautospec + +Rpmautospec is a Python package to automatically generate RPM release fields and changelogs. + +This is the old repository, the project has been moved to GitHub: + +https://github.com/fedora-infra/rpmautospec diff --git a/README.rst b/README.rst deleted file mode 100644 index c4338aa..0000000 --- a/README.rst +++ /dev/null @@ -1,72 +0,0 @@ -Python Package for Automatic Generation of RPM Release Fields and Changelogs -============================================================================ - -.. note:: - - Documentation is available at - https://docs.pagure.org/fedora-infra.rpmautospec/index.html - -This project hosts the ``rpmautospec`` python package and script, which has these functions: - -- Attempt to automatically calculate release numbers and generate an RPM changelog from the dist-git - repository of a package. -- Tag commits in a dist-git repository with build NEVRs (quoting certain special characters). - -Dependencies: - -* python3 -* python3-pygit2 - -General -------- - -The script ``run-rpmautospec.py`` allows testing the various algorithms for automatic release and -changelog generation. It accepts normal CLI options, run ``python run-rpmautospec.py --help`` for -more information. - -Generating a Changelog ----------------------- - -This is how you can use it: - -* Clone a dist-git repository - -:: - - fedpkg clone -a guake - -* Generating the changelog, pointing it to the repository cloned above - -:: - - python run-rpmautospec.py generate-changelog guake - - -Calculating the Next Value for the Release Field ------------------------------------------------- - -Calculate the value for the RPM release field by running the script this way: - -:: - - python run-rpmautospec.py calculate-release - -E.g.: - -:: - - python run-rpmautospec.py calculate-release bash - - -Contributing ------------- - -You need to be legally allowed to submit any contribution to this project. What this -means in detail is laid out in the file ``DCO.txt`` next to this file. The mechanism by which you -certify this is adding a ``Signed-off-by`` trailer to git commit log messages, you can do this by -using the ``--signoff/-s`` option to ``git commit``. - - ---- - -License: MIT