[0.1.0+build.2] A: Markdown Linter & Link Checker

.github/workflows/MarkdownLinter.yml

@@ -0,0 +1,38 @@
+name: Markdown Linter
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  markdownlint:
+    name: Markdown Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v2
+
+      - name: Markdown Linting Action
+        uses: avto-dev/markdown-lint@v1.5.0
+        with:
+          # Disabled in markdownlint.json:
+          #   MD001 - Heading Increment
+          #   MD013 - Line Length
+          #   MD024 - Duplicate Headings
+          #   MD026 - Trailing punctuation in header
+          #   MD033 - No inline HTML
+          #   MD036 - No Emphasis as Heading
+          #   MD041 - No Emphasis as Heading
+          #   MD041 - First line in file should be a H1
+          #   MD022 - Blanks around headings
+          #   MD032 - Blanks around lists
+          #   MD012 - No multiple blanks
+          args: "./README.md ./content/*.md ./docs/*.md"
+      - name: Link Checker
+        id: lc
+        uses: peter-evans/link-checker@v1
+      - name: Fail if links are broken
+        run: exit ${{ steps.lc.outputs.exit_code }}

.markdownlint.json

@@ -0,0 +1,12 @@
+{
+  "MD001": false,
+  "MD013": false,
+  "MD024": false,
+  "MD033": false,
+  "MD036": false,
+  "MD041": false,
+  "MD026": false,
+  "MD012": false,
+  "MD022": false,
+  "MD032": false
+}

CHANGELOG.md

@@ -6,6 +6,13 @@ _Note: New changelog entries are going to be created after the first horizontal
 
 ---
 
+## [[0.1.0+build.2]] - 2022-04-28
+
+### Added
+- Markdown Linter & Link Checker
+
+
+
 ## [[0.1.0+build.1]] - 2022-04-28
 
 ### Changed
@@ -129,3 +136,5 @@ _Note: New changelog entries are going to be created after the first horizontal
 
 [0.1.0+build.1]: https://github.com/Luzkan/GitVersioniser/releases/tag/0.1.0+build.1
 
+[0.1.0+build.2]: https://github.com/Luzkan/GitVersioniser/releases/tag/0.1.0+build.2
+

README.md

@@ -2,7 +2,7 @@
     <img src="./docs/img/logo.png" style="height: 128px; width; 128px;"/>
     <h2 align="center">GitVersioniser</h2>
     <div>
-        <p style="font-style: italic;">Automatic Semantic Versioniser & Change Tracker [0.1.0+build.1]</p>
+        <p style="font-style: italic;">Automatic Semantic Versioniser & Change Tracker [0.1.0]</p>
     </div>
 </div>
 
@@ -62,24 +62,31 @@ _Hint: Think about the repository as a device that can be entirely customized by
 - [Last GitVersioniser Commit](./src/gitversioniser/domain/versioniser/routines/version/core/last_gitversioniser_commit.py) _(default)_
 - [Last Commit](./src/gitversioniser/domain/versioniser/routines/version/core/last_commit.py)
 
+### [**Tagging**](./src/gitversioniser/domain/versioniser/routines/tagging/):
+
+- [Always](./src/gitversioniser/domain/versioniser/routines/tagging/core/always.py) _(default)_
+- [If Patch or Higher](./src/gitversioniser/domain/versioniser/routines/tagging/core/if_patch_or_higher.py)
+- [If Prerelease or Higher](./src/gitversioniser/domain/versioniser/routines/tagging/core/if_prerelease_or_higher.py)
+- [Null](./src/gitversioniser/domain/versioniser/routines/tagging/core/null.py)
+
 ### [**Commit Message**](./src/gitversioniser/domain/versioniser/routines/commit_message/):
 
 - [Prefix Tag](./src/gitversioniser/domain/versioniser/routines/commit_message/core/prefix_tag.py) _(default)_
 - [Suffix Tag](./src/gitversioniser/domain/versioniser/routines/commit_message/core/suffix_tag.py)
 - [Null](./src/gitversioniser/domain/versioniser/routines/commit_message/core/null.py)
 
+### [**Commiting**](./src/gitversioniser/domain/versioniser/routines/contribution/):
+
+- [Push Main Amend](./src/gitversioniser/domain/versioniser/routines/contribution/core/push_main_amend.py) _(default)_
+- [Push Main New](./src/gitversioniser/domain/versioniser/routines/contribution/core/push_main_new.py)
+
 ### [**File Updater**](./src/gitversioniser/domain/versioniser/routines/file_updater/):
 
 - [Versionise Files](./src/gitversioniser/domain/versioniser/routines/file_updater/core/versionise_files.py) _(default)_
 - [Null](./src/gitversioniser/domain/versioniser/routines/file_updater/core/null.py)
 
 ### [**Changelog**](./src/gitversioniser/domain/versioniser/routines/changelog/):
 
-- [Commit Pattern](./src/gitversioniser/domain/versioniser/routines/changelog/commit_pattern/core/commit_pattern.py) _(default)_
-- [Last Commit as Summary](./src/gitversioniser/domain/versioniser/routines/changelog/last_commit_as_summary/core/last_commit_as_summary.py)
-- [Null](./src/gitversioniser/domain/versioniser/routines/changelog/null/core/null.py)
-
-### [**Contribution**](./src/gitversioniser/domain/versioniser/routines/contribution/):
-
-- [Push Main Amend](./src/gitversioniser/domain/versioniser/routines/contribution/core/push_main_amend.py) _(default)_
-- [Push Main New](./src/gitversioniser/domain/versioniser/routines/contribution/core/push_main_new.py)
+- [Commit Pattern](./src/gitversioniser/domain/versioniser/routines/changelog/core/commit_pattern/commit_pattern.py) _(default)_
+- [Last Commit as Summary](./src/gitversioniser/domain/versioniser/routines/changelog/core/last_commit_as_summary/last_commit_as_summary.py)
+- [Null](./src/gitversioniser/domain/versioniser/routines/changelog/core/null/null.py)

main.py

@@ -3,7 +3,7 @@
 from gitversioniser.domain.versioniser.versioniser import Versioniser
 
 
-__version__ = '0.1.0+build.1'
+__version__ = '0.1.0+build.2'
 
 
 def config() -> Config:

setup.py

@@ -2,4 +2,4 @@
 
 
 if __name__ == "__main__":
-    setup(version='0.1.0+build.1')
+    setup(version='0.1.0+build.2')

src/gitversioniser/config/arguments.py

@@ -12,7 +12,7 @@ class Arguments:
 
     @staticmethod
     def get_arguments() -> 'Arguments':
-        parser = argparse.ArgumentParser(description="GitVersioniser [0.1.0+build.1]")
+        parser = argparse.ArgumentParser(description="GitVersioniser [0.1.0+build.2]")
         parser.add_argument(
             "-d", "--target_directory", default='.',
             help="(Setting) Path to repository which shall be versionised. (default: %(default)s)"