chore: Replace bumpversion with bumpver (#278)

* chore: Replace bumpversion with bumpver * ci: Rename devel to main for doc * doc: Fix README.md
aristanetworks · Jul 19, 2023 · 8209902 · 8209902
1 parent 6a574e4
commit 8209902
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 33 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
diff --git a/.github/workflows/devel-doc.yml → .github/workflows/main-doc.yml b/.github/workflows/devel-doc.yml → .github/workflows/main-doc.yml
@@ -1,5 +1,5 @@
 ---
-# This is deploying the latest commits on main to devel documentation
+# This is deploying the latest commits on main to main documentation
 name: Mkdocs
 on:
   push:
@@ -13,7 +13,7 @@ on:
 
 jobs:
   'build_latest_doc':
-    name: 'Update Public devel documentation'
+    name: 'Update Public main documentation'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -30,9 +30,9 @@ jobs:
           git config --global user.name 'github-actions[bot]'
           git config --global user.email 'github-actions[bot]@users.noreply.github.com'
 
-      - name: 'Build mkdocs content and deploy to gh-pages to devel'
+      - name: 'Build mkdocs content and deploy to gh-pages to main'
         run: |
             pip install .[doc]
-            mike deploy --push devel
+            mike deploy --push main
             # This may not always be required
-            mike set-default --push devel
+            mike set-default --push main
diff --git a/anta/__init__.py b/anta/__init__.py
@@ -4,7 +4,7 @@
 import importlib.metadata
 import os
 
-__version__ = importlib.metadata.version("anta")
+__version__ = f"v{importlib.metadata.version('anta')}"
 __credits__ = [
     "Angélique Phillipps",
     "Colin MacGiollaEáin",

diff --git a/README.md → docs/README.md b/README.md → docs/README.md
@@ -54,7 +54,7 @@ Commands:
   nrfu   Run NRFU against inventory devices
 ```
 
-[![anta nrfu table output](imgs/anta-nrfu-table-output.png){ loading=lazy width="1600" }](imgs/anta-nrfu-table-output.png)
+![anta nrfu table output](imgs/anta-nrfu-table-output.png)
 
 
 ## Documentation

diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/requirements-and-installation.md b/docs/requirements-and-installation.md
@@ -50,7 +50,7 @@ which anta
 
 # Chck ANTA version
 anta --version
-anta, version 0.6.0
+anta, version v0.6.0
 ```
 
 ## EOS Requirements

diff --git a/imgs b/imgs
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -139,15 +139,14 @@ markdown_extensions:
       baselevel: 3
   - pymdownx.highlight
   - pymdownx.superfences
-  - pymdownx.snippets
   - pymdownx.superfences
   - pymdownx.tabbed:
       alternate_style: true
 
 # TOC
 docs_dir: docs/
 nav:
-  - Home: index.md
+  - Home: README.md
   - Getting Started: getting-started.md
   - Installation: requirements-and-installation.md
   - Inventory & Tests catalog: usage-inventory-catalog.md

diff --git a/pyproject.toml b/pyproject.toml
@@ -50,7 +50,7 @@ requires-python = ">=3.8"
 
 [project.optional-dependencies]
 dev = [
-  "bump2version==1.0.1",
+  "bumpver==2023.1125",
   "black==23.3.0",
   "flake8==6.0.0",
   "isort==5.10.1",
@@ -100,6 +100,23 @@ anta = "anta.cli:cli"
 include = ["anta*"]
 namespaces = false
 
+################################
+# Version
+################################
+[tool.bumpver]
+current_version = "0.6.0"
+version_pattern = "MAJOR.MINOR.PATCH"
+commit_message  = "bump: Version {old_version} -> {new_version}"
+commit = true
+# No tag
+tag = false
+push = false
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = ['current_version = "{version}"', 'version = "v{version}"']
+"docs/contribution.md" = ["anta    {version}"]
+"docs/requirements-and-installation.md " = ["anta, version v{version}"]
+
 ################################
 # Linting
 ################################