Merge pull request #24 from sarnold/changelogs

Add changelog support

Author: sarnold

.github/workflows/sphinx.yml

@@ -26,8 +26,7 @@ jobs:
 
     - name: Build docs
       run: |
-        tox -e docs-lint
-        tox -e docs
+        tox -e ldocs,docs
 
     - uses: actions/upload-artifact@v4
       with:

CHANGELOG.rst

@@ -2,6 +2,24 @@ Changelog
 =========
 
 
+0.6.2 (2024-06-01)
+------------------
+
+New
+~~~
+- Add changelog feature for release workflows. [Stephen L Arnold]
+
+  * uses ``gitchangelog`` to generate either full changelog.rst or
+    changelog diff from given base tag
+
+Changes
+~~~~~~~
+- Add config option to set changelog file extension. [Stephen L Arnold]
+
+  * allowed options are 'rst' or 'md' depending on the gitchangelog
+    configuration setting for ``output_engine``
+
+
 0.6.1 (2024-05-22)
 ------------------
 

README.rst

@@ -16,6 +16,14 @@ files in yaml instead.
 .. _tox: https://github.com/tox-dev/tox
 .. _pip: https://packaging.python.org/en/latest/key_projects/#pip
 
+The latest new/expanded workflow features now include:
+
+* **tagging support** - tag a set of enabled repositories via config file or
+  command line
+* **changelog support** in ``rSt`` or ``md`` - generate changelog documents
+  for enabled repositories
+
+See the optional feature keys in Usage_ for more info.
 
 Repolite is tested on the 3 primary GH runner platforms, so as long as you
 have a new-ish Python and a ``git`` binary it should run on your platform
@@ -155,32 +163,31 @@ The current version supports minimal command options and there are no
 required arguments::
 
   (dev) user@host repolite (main) $ repolite -h
-  usage: repolite [-h] [--version] [-v] [-q] [-D] [-S] [-i] [-u] [-s] [-a] [-l]
+  usage: repolite [-h] [--version] [-v] [-q] [-D] [-S] [-i] [-u] [-s] [-a] [-g] [-l]
                   [TAG]
 
   Manage local (git) dependencies (default: clone and checkout)
 
   positional arguments:
-    TAG                Tag string override for all repositories (apply with -a)
-                       (default: None)
+    TAG                Optional tag string override (apply with -a) (default: None)
 
   options:
     -h, --help         show this help message and exit
     --version          show program's version number and exit
     -v, --verbose      Display more processing info (default: False)
     -q, --quiet        Suppress output from git command (default: False)
-    -D, --dump-config  Dump default configuration file to stdout (default:
-                       False)
-    -S, --save-config  Save active config to default filename (.ymltoxml.yml)
-                       and exit (default: False)
-    -i, --install      Install existing repositories (python only) (default:
-                       False)
-    -u, --update       Update existing repositories (default: False)
+    -D, --dump-config  Dump default configuration file to stdout (default: False)
+    -S, --save-config  Save active config to default filename (.ymltoxml.yml) and exit
+                       (default: False)
+    -i, --install      Install enabled repositories (python only) (default: False)
+    -u, --update       Update existing/enabled repositories (default: False)
     -s, --show         Display current repository state (default: False)
-    -a, --apply-tag    Apply the given tag (see TAG arg) or use one from config
-                       file (default: False)
-    -l, --lock-config  Lock active configuration in new config file and checkout
-                       hashes (default: False)
+    -a, --apply-tag    Apply the given tag (see TAG arg) or use one from config file
+                       (default: False)
+    -g, --changelog    Run gitchangelog in enabled repositories, create files in top_dir
+                       (default: False)
+    -l, --lock-config  Lock active configuration in new config file and checkout hashes
+                       (default: False)
 
 Configuration settings
 ----------------------
@@ -207,6 +214,9 @@ Configuration keys for optional extra features/behavior:
                      (requires ``git-lfs`` to be installed first)
 :repo_init_submodules: if true, initialize/update git submodules in that repository
 :repo_install: if true, try to install the repo with pip_
+:repo_changelog_ext: changelog file extension (default: ``rst``)
+:repo_changelog_base: base version to use for changelog data
+:repo_gen_changes: if true, generate changelog file in ``top_dir``
 
 Configuration keys that change repository state:
 
@@ -219,6 +229,8 @@ Configuration keys that change repository state:
 
 Notes:
 
+* if your gitchangelog_ config uses Markdown, set ``repo_changelog_ext`` to
+  ``md`` instead of ``rst``
 * when tagging, tag from commandline is only used when config value is ``null``
 * when tagging, ``create_tag_annotated`` and ``create_tag_signed`` are
   mutually exclusive, so only enable one of them
@@ -236,6 +248,7 @@ Notes:
 * you may want to add your ``top_dir`` path or default local config file
   patterns to your ``.gitignore`` file
 
+.. _gitchangelog: https://github.com/sarnold/gitchangelog
 
 Dev tools
 =========

requirements.txt

@@ -1,2 +1,5 @@
-munch
+gitchangelog @ https://github.com/sarnold/gitchangelog/releases/download/3.2.0/gitchangelog-3.2.0-py3-none-any.whl
+importlib-metadata; python_version < '3.8'
+importlib-resources; python_version < '3.10'
+munch[yaml]
 PyYAML

setup.cfg

@@ -24,6 +24,7 @@ setup_requires =
     setuptools_scm[toml]
 
 install_requires =
+    gitchangelog @ https://github.com/sarnold/gitchangelog/releases/download/3.2.0/gitchangelog-3.2.0-py3-none-any.whl
     importlib-metadata; python_version < '3.8'
     importlib-resources; python_version < '3.10'
     munch[yaml]

src/repolite/data/example.yml

@@ -17,6 +17,9 @@ repos:
     repo_create_tag_signed: false
     repo_push_new_tags: false
     repo_signing_key: null
+    repo_changelog_ext: rst
+    repo_changelog_base: null
+    repo_gen_changes: false
     repo_use_rebase: false
     repo_has_lfs_files: false
     repo_init_submodules: false
@@ -36,6 +39,9 @@ repos:
     repo_create_tag_signed: false
     repo_push_new_tags: false
     repo_signing_key: null
+    repo_changelog_ext: rst
+    repo_changelog_base: null
+    repo_gen_changes: false
     repo_use_rebase: false
     repo_has_lfs_files: false
     repo_init_submodules: false

src/repolite/repolite.py

@@ -96,6 +96,7 @@ def check_repo_state(ucfg):
         os.chdir(top_dir)
     except OSError as exc:
         logging.exception("Could not change to repo directory: %s", exc)
+        sys.exit(1)
 
     sorted_dir_list = sorted([x for x in top_dir.iterdir() if x.is_dir()])
     repo_name_list = []
@@ -113,6 +114,33 @@ def check_repo_state(ucfg):
     return is_state_valid
 
 
+def generate_change_data(mrepo, base_tag, dir_name, cur_tag):
+    """
+    Generate a changelog (full or diff) for the given repository and drop
+    it in the configured top_dir directory. Checks repo config for base
+    tag to decide full vs diff.
+
+    :param mrepo: a Munch repo obj with Munch repos item
+    :type mrepo: Munch obj
+    :param base_tag: starting tag for change diff
+    :type base_tag: str or None
+    :dir_name: directory name for output (top_dir)
+    :type dir_name: str
+    :param cur_tag: ending tag for change diff (tag on current commit)
+    :type cur_tag: str
+    """
+    base_cmd_str = 'gitchangelog'
+    output_file = f'{dir_name}/{mrepo.name}-CHANGELOG.{mrepo.item.repo_changelog_ext}'
+
+    if base_tag:
+        base_cmd_str = base_cmd_str + f' {base_tag}..{cur_tag}'
+
+    logging.debug('Running gitchangelog cmd: %s', base_cmd_str)
+    chg_data = sp.check_output(split(base_cmd_str))
+    Path(output_file).write_bytes(chg_data)
+    logging.info('ChangeLog file: %s', Path(output_file))
+
+
 def install_with_pip(pip_name, quiet=False):
     """
     Install a python repository via pip; this should be done in a local
@@ -403,6 +431,43 @@ def process_git_repos(flags, repos, pull, quiet):
     os.chdir(work_dir)
 
 
+def process_repo_changes(ucfg):
+    """
+    Generate a changelog for any repos with the ``repo_gen_changes`` flag
+    set. Note we do not check repo state here, we just process each valid
+    repo entry.
+
+    :param ucfg: Munch configuration object extracted from config file
+    :type ucfg: Munch cfgobj
+    :param quiet: pass the ``quiet`` cmd line flag to install cmd
+    """
+    work_dir, top_dir = resolve_top_dir(ucfg.top_dir)
+    valid_repo_state = check_repo_state(ucfg)
+    if not valid_repo_state:
+        raise DirectoryTypeError('Inconsistent directories; try running repolite first?')
+
+    git_get_tags = 'git tag --sort=taggerdate'
+    git_check_tag = 'git tag --points-at'
+
+    for item in [x for x in ucfg.repos if x.repo_enable and x.repo_gen_changes]:
+        repo = Munch()
+        repo.name = item.repo_name
+        repo.item = Munch(item)
+        git_dir = item.repo_alias if item.repo_alias else item.repo_name
+        os.chdir(git_dir)
+
+        all_tags = sp.check_output(split(git_get_tags), text=True).splitlines()
+        logging.debug('%s tag list: %s', item.repo_name, all_tags)
+        commit_tags = sp.check_output(split(git_check_tag), text=True).splitlines()
+        logging.debug('commit tag(s): %s', commit_tags)
+        last_tag = all_tags[-1] if all_tags and all_tags[-1] in commit_tags else ''
+
+        generate_change_data(repo, item.repo_changelog_base, top_dir, last_tag)
+
+        os.chdir(top_dir)
+    os.chdir(work_dir)
+
+
 def process_repo_install(ucfg, quiet):
     """
     Install any repos with the ``repo_install`` flag set. Note we do not
@@ -499,13 +564,13 @@ def main(argv=None):  # pragma: no cover
         "-i",
         "--install",
         action="store_true",
-        help="Install existing repositories (python only)",
+        help="Install enabled repositories (python only)",
     )
     parser.add_argument(
         "-u",
         "--update",
         action="store_true",
-        help="Update existing repositories",
+        help="Update existing/enabled repositories",
     )
     parser.add_argument(
         "-s",
@@ -520,6 +585,12 @@ def main(argv=None):  # pragma: no cover
         dest="apply",
         help="Apply the given tag (see TAG arg) or use one from config file",
     )
+    parser.add_argument(
+        "-g",
+        "--changelog",
+        action="store_true",
+        help="Run gitchangelog in enabled repositories, create files in top_dir",
+    )
     parser.add_argument(
         '-l',
         '--lock-config',
@@ -531,7 +602,7 @@ def main(argv=None):  # pragma: no cover
         "tag",
         metavar="TAG",
         nargs='?',
-        help="Tag string override for all repositories (apply with -a)",
+        help="Optional tag string override (apply with -a)",
         type=str,
     )
 
@@ -560,6 +631,9 @@ def main(argv=None):  # pragma: no cover
         sys.exit(0)
 
     try:
+        if opts.changelog:
+            process_repo_changes(cfg)
+            sys.exit(0)
         if opts.install:
             process_repo_install(cfg, opts.quiet)
             sys.exit(0)

tests/conftest.py

@@ -15,6 +15,7 @@
     'git_dummy',
     '--allow-nested',
     '--constant-sha',
+    '--commits=10',
     '--branches=5',
     '--diverge-at=2',
     '--git-dir',

tests/test_repolite.py

@@ -30,6 +30,9 @@
     repo_create_tag_signed: false
     repo_push_new_tags: false
     repo_signing_key: null
+    repo_changelog_ext: rst
+    repo_changelog_base: null
+    repo_gen_changes: true
     repo_use_rebase: false
     repo_has_lfs_files: false
     repo_init_submodules: false
@@ -49,6 +52,9 @@
     repo_create_tag_signed: false
     repo_push_new_tags: false
     repo_signing_key: null
+    repo_changelog_ext: rst
+    repo_changelog_base: null
+    repo_gen_changes: true
     repo_use_rebase: false
     repo_has_lfs_files: false
     repo_init_submodules: false
@@ -201,3 +207,27 @@ def test_repolite_locked_cfg(tmp_path, script_loc, tmpdir_session):
     update = False
     quiet = False
     create_locked_cfg(cfg, pfile, quiet, tpath)
+
+
+def test_repolite_changes(script_loc, tmpdir_session):
+    """
+    Show the repos in the test config.
+    """
+    cfg.top_dir = str(tmpdir_session / 'ext')
+
+    for repo in cfg.repos:
+        pure_path = PurePath(script_loc, 'testdata', repo.repo_url)
+        # print(f'PurePath is {pure_path}')
+        full_path = Path(pure_path).resolve()
+        # print(f'Type is {type(full_path)}')
+        # print(f'Path is {full_path}')
+        print(f'Path string is {full_path.__str__()}')
+        repo.repo_url = full_path.__str__()
+        # print(f'Munch type is {type(repo.repo_url)}')
+        # print(f'Munch value is {repo.repo_url}')
+
+    process_repo_changes(cfg)
+    changelogs = list(Path(cfg.top_dir).glob('**/*.rst'))
+    for fpath in changelogs:
+        print(fpath)
+        assert 'CHANGELOG.rst' in str(fpath)