Release Version 1.1.1

### Fixed

- Fixed `yaclog release -C -c` not committing changes to cargo.toml

.github/dependabot.yml

@@ -0,0 +1,8 @@
+# Set update schedule for GitHub Actions
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every weekday
+      interval: "daily"

.github/workflows/python-publish.yml

@@ -9,14 +9,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ 3.8, 3.9 ]
-        click-version: [ click~=7.0, click~=8.0 ]
+        python-version: [ "3.8", "3.9", "3.10" ]
+        click-version: [ "click~=7.0", "click~=8.0" ]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4.2.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -45,10 +45,10 @@ jobs:
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4.2.0
         with:
           python-version: '3.x'
 

CHANGELOG.md

@@ -2,7 +2,28 @@
 
 All notable changes to this project will be documented in this file
 
-## Unreleased
+## Version 1.1.1 - 2022-08-15
+
+### Fixed
+
+- Fixed `yaclog release -C -c` not committing changes to cargo.toml
+
+
+## Version 1.1.0 - 2022-08-14
+
+### Added
+
+- Added a flag to update Rust Cargo.toml files when releasing a new version
+
+
+## Version 1.0.4 - 2022-04-08
+
+### Fixed
+
+- Fixed tests folder being installed as a package
+
+
+## Version 1.0.3 - 2021-05-12
 
 ### Fixed
 

pyproject.toml

@@ -1,9 +1,59 @@
 [build-system]
 requires = [
-    "setuptools >= 35.0.2",
-    "setuptools_scm[toml] >= 3.4",
+    "setuptools>=61",
+    "setuptools_scm>=6.2",
     "wheel"
 ]
 build-backend = "setuptools.build_meta"
 
-[tool.setuptools_scm]
+[project]
+name = "yaclog"
+description = "Yet another changelog CLI tool."
+readme = "README.md"
+authors = [{ name = "Andrew Cassidy", email = "drewcassidy@me.com" }]
+keywords = ["changelog", "commandline", "markdown"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Topic :: Text Processing :: Markup :: Markdown",
+    "Topic :: Software Development :: Version Control :: Git",
+    "Topic :: Utilities"
+]
+
+requires-python = ">= 3.8"
+dependencies = [
+    "Click >= 7.0",
+    "GitPython >= 3",
+    "packaging >= 20",
+    "tomlkit >= 0.11"
+
+]
+dynamic = ["version"]
+
+[project.optional-dependencies]
+docs = [
+    "Sphinx >= 3.5",
+    "sphinx-click >= 2.7",
+    "sphinx-rtd-theme",
+    "myst-parser >= 0.14",
+]
+
+[project.scripts]
+yaclog = "yaclog.cli.__main__:cli"
+
+[project.urls]
+Source = "https://github.com/drewcassidy/yaclog"
+Changelog = "https://github.com/drewcassidy/yaclog/blob/main/CHANGELOG.md"
+Docs = "https://yaclog.readthedocs.io/"
+
+[tool.setuptools_scm]
+
+[tool.setuptools.packages.find]
+include = ["yaclog"]

setup.cfg

@@ -1,50 +0,0 @@
-[metadata]
-# until setuptools supports PEP621, this will have to do
-name = yaclog
-description = Yet another changelog CLI tool.
-author = Andrew Cassidy
-license = AGPLv3
-license_file = LICENSE.md
-long_description = file: README.md
-long_description_content_type = text/markdown
-
-keywords = changelog, commandline, markdown
-classifiers =
-    Development Status :: 5 - Production/Stable
-    Intended Audience :: Developers
-    License :: OSI Approved :: GNU Affero General Public License v3
-    Operating System :: OS Independent
-    Programming Language :: Python :: 3 :: Only
-    Programming Language :: Python :: 3
-    Programming Language :: Python :: 3.8
-    Programming Language :: Python :: 3.9
-    Topic :: Text Processing :: Markup :: Markdown
-    Topic :: Software Development :: Version Control :: Git
-    Topic :: Utilities
-
-project_urls =
-    Source = https://github.com/drewcassidy/yaclog
-    Changelog = https://github.com/drewcassidy/yaclog/blob/main/CHANGELOG.md
-    Docs = https://yaclog.readthedocs.io/
-
-[options]
-install_requires =
-    Click >= 7.0, < 9.0
-    GitPython >= 3
-    packaging >= 20
-python_requires = >= 3.8
-packages = find:
-
-[options.extras_require]
-docs =
-    Sphinx >= 3.5
-    sphinx-click >= 2.7
-    sphinx-rtd-theme
-    myst-parser >= 0.14
-
-[options.entry_points]
-console_scripts =
-    yaclog = yaclog.cli.__main__:cli
-
-[options.packages.find]
-exclude = tests.*

tests/test_cli.py

@@ -217,6 +217,31 @@ class TestRelease(unittest.TestCase):
             self.assertIn(repo.head.commit.hexsha[0:7], result.output)
             self.assertEqual(repo.tags[0].name, '1.0.0')
 
+    def test_cargo(self):
+        """Test updating cargo.toml files"""
+        runner = CliRunner()
+        with runner.isolated_filesystem():
+            with open("Cargo.toml", "w") as fp:
+                fp.write((
+                    '[package]\n'
+                    'name = "dummy"\n'
+                    'version = "0.3.4"\n'
+                    'authors = ["Andrew Cassidy <drewcassidy@me.com>"]\n'
+                    'description = "A dummy crate used for testing yaclog"\n'
+                    'keywords = ["does", "not", "exist"]\n'
+                    'edition = "2018"\n'
+                ))
+
+            runner.invoke(cli, ['init'])  # create the changelog
+            runner.invoke(cli, ['entry', '-b', 'entry number 1'])
+
+            result = runner.invoke(cli, ['release', 'Version 1.0.0', '-C'])
+            check_result(self, result)
+
+            with open("Cargo.toml", "r") as fp:
+                self.assertIn('version = "1.0.0"', fp.read())
+                # we're just going to trust tomlkit not to mangle everything else
+
 
 class TestShow(unittest.TestCase):
 

yaclog/cli/__main__.py

@@ -16,6 +16,7 @@
 
 import datetime
 import os.path
+from ..cli import cargo_toml
 
 import click
 import git
@@ -199,9 +200,11 @@ def entry(obj: Changelog, bullets, paragraphs, section_name, version_name):
 @click.option('-c', '--commit', is_flag=True,
               help='Create a git commit tagged with the new version number. '
                    'If there are no changes to commit, the current commit will be tagged instead.')
+@click.option('-C', '--cargo', '-🦀', is_flag=True,
+              help='Update the version in a Rust cargo.toml manifest file.')
 @click.argument('version_name', metavar='VERSION', type=str, default=None, required=False)
 @click.pass_obj
-def release(obj: Changelog, version_name, rel_seg, pre_seg, commit):
+def release(obj: Changelog, version_name, rel_seg, pre_seg, commit, cargo):
     """
     Release VERSION, or a version incremented from the last release.
 
@@ -213,7 +216,7 @@ def release(obj: Changelog, version_name, rel_seg, pre_seg, commit):
     other kinds of prerelease.
     """
 
-    if rel_seg is None and pre_seg is None and not version_name and not commit:
+    if rel_seg is None and pre_seg is None and not version_name and not commit and not cargo:
         click.echo('Nothing to release!')
         raise click.Abort
 
@@ -246,6 +249,14 @@ def release(obj: Changelog, version_name, rel_seg, pre_seg, commit):
         obj.write()
         click.echo(f"Renamed {click.style(old_name, fg='blue')} to {click.style(new_name, fg='blue')}")
 
+    short_version, *_ = yaclog.version.extract_version(cur_version.name)
+    if not short_version:
+        short_version = cur_version.name.replace(' ', '-')
+
+    if cargo:
+        cargo_toml.set_version("Cargo.toml", str(short_version))
+        click.echo("Updated Cargo.toml")
+
     if commit:
         repo = git.Repo(os.curdir)
 
@@ -254,6 +265,9 @@ def release(obj: Changelog, version_name, rel_seg, pre_seg, commit):
 
         repo.index.add(obj.path)
 
+        if cargo:
+            repo.index.add("Cargo.toml")
+
         tracked = len(repo.index.diff(repo.head.commit))
         untracked = len(repo.index.diff(None))
 
@@ -277,10 +291,6 @@ def release(obj: Changelog, version_name, rel_seg, pre_seg, commit):
         else:
             commit = repo.head.commit
 
-        short_version, *_ = yaclog.version.extract_version(cur_version.name)
-        if not short_version:
-            short_version = cur_version.name.replace(' ', '-')
-
         repo_tag = repo.create_tag(short_version, ref=commit, message=cur_version.body(False))
         click.echo(f"Created tag {click.style(repo_tag.name, fg='green')}.")
 

yaclog/cli/cargo_toml.py

@@ -0,0 +1,33 @@
+#  yaclog: yet another changelog tool
+#  Copyright (c) 2022. Andrew Cassidy
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Affero General Public License as
+#  published by the Free Software Foundation, either version 3 of the
+#  License, or (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Affero General Public License for more details.
+#
+#  You should have received a copy of the GNU Affero General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+from tomlkit import dumps
+from tomlkit import parse
+
+
+def set_version(path, version):
+    """
+    Set the version string in a cargo.toml file
+
+    :param path: path-like file location
+    :param version: version string to overwrite with
+    """
+    with open(path, 'r+') as fp:
+        toml = parse(fp.read())
+        toml['package']['version'] = version
+        fp.seek(0)
+        fp.write(dumps(toml))
+        fp.truncate()