build(version): bump version 0.3.0 → 0.3.1

docs(readme): Update project usage in own repo

See merge request nofusscomputing/projects/gitlab-ci!10

.cz.yaml

@@ -4,4 +4,4 @@ commitizen:
   name: cz_conventional_commits
   tag_format: v$major.$minor.$patch$prerelease
   update_changelog_on_bump: true
-  version: 0.3.0
+  version: 0.3.1

CHANGELOG.md

@@ -1,3 +1,15 @@
+## v0.3.1 (2022-01-11)
+
+### Bug Fixes
+
+- **pylint**: [4b6cc317](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/4b6cc3176fc4acc3b7dbb954162802af9cbb4c68) - install the required packages for files being checked [ [#7](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/issues/7) ]
+- **pylint**: [936299ae](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/936299aefc6eadf9cbfec3152b352b321969cfab) - fix bug introduced in code quality commit [ [#7](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/issues/7) ]
+- **commit_footer**: [2ac22c0e](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/2ac22c0e914016a8944ff9b94640f3e87f409069) - fix bug introduced in code quality commit [ [#7](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/issues/7) ]
+
+### Documentaton / Guides
+
+- **readme**: [8ac36de8](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/8ac36de8e0f113ce17d54dfce1345a0adab41bc8) - Updated with an example .gitlab-ci.yml example [ [#2](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/issues/2) [!10](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/merge_requests/10) ]
+
 ## v0.3.0 (2021-08-12)
 
 ### BREAKING CHANGE

README.md

@@ -17,7 +17,7 @@ This repository is hosted on [gitlab.com](https://gitlab.com/nofusscomputing/pro
 
 links:
 
-- [![Open Issues](https://img.shields.io/badge/dynamic/json?color=ff782e&logo=gitlab&style=plastic&label=Open%20Issues&query=%24.statistics.counts.opened&url=https%3A%2F%2Fgitlab.com%2Fapi%2Fv4%2Fprojects%2F28543717%2Fissues_statistics) Issues](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/issues)
+- [Issues](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/issues)
 
 - [Merge Requests (Pull Requests)](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/merge_requests)
 
@@ -30,7 +30,7 @@ Each CI/CD job is contained within its own sub-folder. Each sub-folder has a rea
 
 ### gitlab-ci layout
 
-We use the following branches:
+We use the following branches *(these jobs assume you do as well)*:
  - `master` - Considered as the stable branch
  - `development` considered as unstable
 
@@ -62,6 +62,37 @@ The CI stages for these jobs are as follows, and in the order expected by the jo
 - publish
     > placement of build objects to external sources
 
+### .gitlab-ci.yml example
+
+example:
+``` yaml
+stages:
+    - validation
+    - build
+    - prepare
+    - test
+    - release
+    - sync
+    - publish
+
+variables:
+    GIT_SUBMODULE_STRATEGY: recursive
+    MY_PROJECT_ID: "{your_project_id}"
+
+include:
+  - project: nofusscomputing/projects/gitlab-ci
+    ref: 68b6bc3bfacf0770e10d2e10a5c57952070d44fe
+    file:
+      - conventional_commits/.gitlab-ci.yml
+      - gitlab_release/.gitlab-ci.yml
+      - git_push_mirror/.gitlab-ci.yml
+      - ansible/.gitlab-ci.yml
+
+```
+| :bulb: Tip |
+|:----|
+|  *Use a project import in your `.gitlab-ci.yml` file that is tied to a specific `ref`. for example a commit or tag. Also ensure that the `gitlab-ci` `git sub-module` and the `ref` as part of the includes matches.*  |
+
 
 ### Artifacts
 Any artifacts by jobs will be created in folders named after the stage.
@@ -69,6 +100,8 @@ Any artifacts by jobs will be created in folders named after the stage.
 preference is placed on jobs to output JUnit.xml test reports. This is because they are visible in merge requests.
 
 
+## Git Sub-Module setup
+
 It is recommended that you set-up this repo as a git sub-module to your repo and that you configure it to a set commit/tag. This ensures that any change to `gitlab-ci` repo, does not effect your CI/CD jobs.
 
 run the following commands:

ansible/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+2021-08-12 03:32:36 +0000 [389bc08](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/389bc08d7686153fb374aa83d440c35c9b4eac90) - build(version): bump version 0.3.0rc1 → 0.3.0  
 2021-08-11 13:47:34 +0930 [def31ef](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/def31ef562c0002713401652657d59320548ee85) - style(yaml_lint): fixed yaml lint errors  
 2021-08-04 03:23:08 +0000 [eb5cc8a](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/eb5cc8a0e2885a9ed16a8d1a81611aec4d5a4d31) - build(version): bump version 0.3.0rc0 → 0.3.0rc1  
 2021-08-04 03:13:54 +0000 [09dcb65](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/09dcb65b090f59e9f8a6bea5eba4bb98bddbad3d) - build(version): bump version 0.2.1 → 0.3.0rc0  

conventional_commits/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+2021-08-12 03:32:36 +0000 [389bc08](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/389bc08d7686153fb374aa83d440c35c9b4eac90) - build(version): bump version 0.3.0rc1 → 0.3.0  
 2021-08-12 12:47:23 +0930 [3360a15](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/3360a15fde12682edfd9044d2541dc819615b838) - fix(commit_message): fixed commit message check if there is only one commit to the branch  
 2021-08-11 13:47:34 +0930 [def31ef](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/def31ef562c0002713401652657d59320548ee85) - style(yaml_lint): fixed yaml lint errors  
 2021-08-04 03:23:08 +0000 [eb5cc8a](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/eb5cc8a0e2885a9ed16a8d1a81611aec4d5a4d31) - build(version): bump version 0.3.0rc0 → 0.3.0rc1  

git_push_mirror/CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog
 
+2021-08-12 03:32:36 +0000 [389bc08](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/389bc08d7686153fb374aa83d440c35c9b4eac90) - build(version): bump version 0.3.0rc1 → 0.3.0  
 2021-08-11 13:47:34 +0930 [def31ef](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/def31ef562c0002713401652657d59320548ee85) - style(yaml_lint): fixed yaml lint errors  
 2021-08-04 03:23:08 +0000 [eb5cc8a](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/eb5cc8a0e2885a9ed16a8d1a81611aec4d5a4d31) - build(version): bump version 0.3.0rc0 → 0.3.0rc1  
 2021-08-04 03:13:54 +0000 [09dcb65](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/09dcb65b090f59e9f8a6bea5eba4bb98bddbad3d) - build(version): bump version 0.2.1 → 0.3.0rc0  

gitlab_release/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+2021-08-12 14:46:26 +0930 [2ac22c0](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/2ac22c0e914016a8944ff9b94640f3e87f409069) - fix(commit_footer): fix bug introduced in code quality commit  
+2021-08-12 14:42:16 +0930 [ccc601f](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/ccc601f641a9b07b63a160d779c5037481316e75) - style(cz_nfc): code quality on cz_nfc.py  
+2021-08-12 14:27:41 +0930 [5676c5e](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/5676c5ee376f574a8581e8c8f4810eb5a7c511ba) - style(commit_footer): code quality on setup.py  
+2021-08-12 14:26:43 +0930 [3d69e57](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/3d69e57714cd529b13ddc9c575c2dc955a350dd9) - style(commit_footer): code quality on __main__.py  
+2021-08-12 14:21:34 +0930 [c093c31](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/c093c31cbd12989f7109dbcb6fd4f029c42a3919) - style(commit_footer): code quality on commits.py  
+2021-08-12 03:32:36 +0000 [389bc08](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/389bc08d7686153fb374aa83d440c35c9b4eac90) - build(version): bump version 0.3.0rc1 → 0.3.0  
 2021-08-11 13:47:34 +0930 [def31ef](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/def31ef562c0002713401652657d59320548ee85) - style(yaml_lint): fixed yaml lint errors  
 2021-08-11 12:17:50 +0930 [63af1ef](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/63af1efb4fd92a9f8755f766728a18d8f390b805) - fix(commit_footer_refs): Use the current git branch for comparison.  
 2021-08-08 15:57:50 +0930 [dc13d4f](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/dc13d4f2841038c085dcf29dfb0b0c5d2f00f099) - docs(gitlab_release): Added user docs to fix errors from ci job 'commit footer refs'  

gitlab_release/python-module/commit_footer/__main__.py

@@ -1,7 +1,6 @@
 #-*- coding: utf-8 -*-
 
-from commit_footer.cli import main
+import cli
 
 if __name__ == '__main__':
-   main()
-
+    cli.main()

gitlab_release/python-module/commit_footer/commits.py

@@ -2,8 +2,8 @@
 #-*- coding: utf-8 -*-
 
 import os
-import git
 import re
+import git
 
 class Commits:
 
@@ -11,7 +11,7 @@ class Commits:
     def __init__(self):
 
         self._repository = git.Repo(os.getcwd())
-        
+
         self._failed = []
         merge_base = self._repository.merge_base('development', self._repository.active_branch)
         self._merge_base = str(merge_base[0])
@@ -20,22 +20,22 @@ class Commits:
 
 
     def fetch_all(self) -> bool: # get the commits and filter to only the current branch
-        
+
         commits = list(self._repository.iter_commits(self._repository.active_branch))
 
         clean = True
-        Branch_commits = []
+        branch_commits = []
         for remove in commits:
 
             if str(remove).lower() == self._merge_base.lower():
-                
+
                 clean = False
 
             if clean:
 
-                Branch_commits.append(remove)
+                branch_commits.append(remove)
 
-        self._commits = Branch_commits
+        self._commits = branch_commits
 
 
     def fetch(self, sha1:str) -> str: # fetch a single git message
@@ -48,64 +48,82 @@ class Commits:
 
         return ''
 
-
-    def footer(self, git_message:str) -> list: # Get the last line of the commit message if has more than 2 lines
+    # Get the last line of the commit message if has more than 2 lines
+    def footer(self, git_message:str) -> list:
+        footer = None
 
         if git_message.count("\n") > 2:
 
             footer_line = git_message.split("\n")
             footer_line = footer_line[(len(footer_line)-1)]
 
-            footer = re.findall(r"([\!|\#][0-9]+)", str(git_message))
+            commit_footer = re.findall(r"([\!|\#][0-9]+)", str(git_message))
 
-            if len(footer) > 0:
-                return footer
+            if len(commit_footer) > 0:
+                footer = commit_footer
             else:
-                return False
+                footer = False
 
-        return None
+        return footer
 
 
     def junit(self) -> bool:
-        junit = False
 
-        junit_testsuites = '<testsuites id="Commits Messages Check" name="commit footer references" errors="{0}" tests="{1}" time="0">'.format(len(self._failed), len(self._commits))
-        junit_testsuite = '<testsuite errors="{0}" name="commit footer references" tests="{1}">'.format(len(self._failed), len(self._commits))
+        junit_testsuites = '''<testsuites
+                id="Commits Messages Check"
+                name="commit footer references"
+                errors="{0}"
+                tests="{1}"
+                time="0">'''.format(len(self._failed), len(self._commits))
+
+        junit_testsuite = '''<testsuite
+                errors="{0}"
+                name="commit footer references"
+                tests="{1}">'''.format(len(self._failed), len(self._commits))
 
         junit_testcase = ''
         for commit in self._failed:
             for key in commit:
                 junit_testcase += '''
-                <testcase classname="{0}" file="{2}/gitlab_release/README.md" line="0" name="No commit footer references found" time="0" timestamp="date">
-                    <failure message="No References in the commit footer" type="validation">{1}</failure>
+                <testcase 
+                    classname="{0}"
+                    file="{2}/gitlab_release/README.md"
+                    line="0"
+                    name="No commit footer references found"
+                    time="0"
+                    timestamp="date">
+                        <failure 
+                            message="No References in the commit footer"
+                            type="validation">{1}</failure>
                     <system-out>
                         <![CDATA[ {1} ]]>
                     </system-out>
                     <system-err>
                     <![CDATA[ {1} ]]>
                 </system-err>
-            </testcase>'''.format(key, str(commit[key], os.environ['ROOT_DIR']))
+            </testcase>'''.format(key, str(commit[key]), os.environ['ROOT_DIR'])
 
 
         if junit_testcase == '':
-           junit_testcase = '<testcase classname="Commit footer references check" file="' + os.environ['ROOT_DIR'] + '/gitlab_release/README.md" name="has commit footer references"/>'
+            junit_testcase = '''<testcase
+                    classname="Commit footer references check"
+                    file="' + os.environ['ROOT_DIR'] + '/gitlab_release/README.md"
+                    name="has commit footer references"/>'''
 
         junit_close = '</testsuite></testsuites>'
         print(str(junit_testsuites))
         print(str(junit_testsuite))
         print(str(junit_testcase))
         print(str(junit_close))
-        
+
 
     def check(self) -> bool:
         check = True
 
-        start_check = False
-
         for commit in self._commits:
 
             if commit.message.count('\n') < 3:
-               continue
+                continue
             footer = self.footer(commit.message)
 
             if footer is False:
@@ -119,5 +137,3 @@ class Commits:
             check = False
 
         return check
-
-

gitlab_release/python-module/commit_footer/setup.py

@@ -11,4 +11,3 @@ setup(
         'console_scripts': ['commit_footer=cli:main'],
     },
 )
-

gitlab_release/python-module/cz_nfc/cz_nfc.py

@@ -2,19 +2,37 @@
 #-*- coding: utf-8 -*-
 
 import os
-import git as Git
 import re
 
+import git as Git
+
 from commitizen import git
 from commitizen.cz.base import BaseCommitizen
 
 
-class nfc_cz(BaseCommitizen):
+class NoFussCz(BaseCommitizen):
     bump_pattern = r"^(break|new|fix|feat|hotfix|ci|docs)"
-    bump_map = {"break": "MAJOR", "new": "MINOR", "feat": "MINOR","fix": "PATCH", "hotfix": "PATCH", "ci": "PATCH", "docs": "PATCH"}
+    bump_map = {
+        "break": "MAJOR",
+        "new": "MINOR",
+        "feat": "MINOR",
+        "fix": "PATCH",
+        "hotfix": "PATCH",
+        "ci": "PATCH",
+        "docs": "PATCH"
+    }
 
     changelog_pattern = "^(break|new|fix|feat|hotfix|refactor|ci|docs)"
-    change_type_order = ["BREAKING CHANGE", "feat", "fix", "refactor", "perf", "docs", "ci"]
+    change_type_order = [
+        "BREAKING CHANGE",
+        "feat",
+        "fix",
+        "refactor",
+        "perf",
+        "docs",
+        "ci"
+    ]
+
     change_type_map = {
         "feat": "Features",
         "fix": "Bug Fixes",
@@ -82,8 +100,9 @@ class nfc_cz(BaseCommitizen):
         else:
             footer_references = ''
 
-        m = parsed_message["message"]
-        parsed_message["message"] = f"[{rev_short}](" + os.environ['CI_PROJECT_URL'] + f"/-/commit/{rev}) - {m}" + footer_references
+        msg = parsed_message["message"]
+        project_url = os.environ['CI_PROJECT_URL']
+        parsed_message["message"] = f"[{rev_short}]({project_url}/-/commit/{rev}) - {msg}{footer_references}"
 
         return parsed_message
 
@@ -95,4 +114,4 @@ class nfc_cz(BaseCommitizen):
         raise NotImplementedError("Not Implemented yet")
 
 
-discover_this = nfc_cz
+discover_this = NoFussCz

python/.gitlab-ci.yml

@@ -7,6 +7,7 @@
 .PyLint:
     variables:
         PYLINT_PATH: "/*/python-module/*/*.py"
+        PYLINT_RC_PATH: "/python/.pylintrc"
     stage: validation
     before_script:
         - if [ "0$JOB_ROOT_DIR" == "0" ]; then ROOT_DIR=gitlab-ci; else ROOT_DIR=$JOB_ROOT_DIR ; fi
@@ -24,11 +25,13 @@
     script:
         - PYLINT_PATH=$ROOT_DIR$PYLINT_PATH
         - echo "[DEBUG] PYLINT_PATH[$PYLINT_PATH]"
-        - python3 -m pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter $PYLINT_PATH > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.json"
+        - PYLINT_RC_PATH=$ROOT_DIR$PYLINT_RC_PATH
+        - echo "[DEBUG] PYLINT_RC_PATH[$PYLINT_RC_PATH]"
+        - python3 -m pylint --rcfile $PYLINT_RC_PATH --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter $PYLINT_PATH > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.json"
 
-        - python3 -m pylint --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter $PYLINT_PATH > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html"
+        - python3 -m pylint --rcfile $PYLINT_RC_PATH --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter $PYLINT_PATH > "$CI_PROJECT_DIR/artifacts/$CI_JOB_STAGE/tests/gl-code-quality-report.html"
 
-        - PyPIScore=$(python3 -m pylint --exit-zero $PYLINT_PATH | sed -n 's/^Your code has been rated at \([-0-9./]*\).*/\1/p')
+        - PyPIScore=$(python3 -m pylint --rcfile $PYLINT_RC_PATH --exit-zero $PYLINT_PATH | sed -n 's/^Your code has been rated at \([-0-9./]*\).*/\1/p')
 
         - *pylint_badge
 

python/.pylintrc

@@ -0,0 +1,5 @@
+[MASTER]
+disable=
+    C0114, # missing-module-docstring
+    C0115, # missing-class-docstring
+    C0116, # missing-function-docstring

python/CHANGELOG.md

@@ -1,3 +1,7 @@
 # Changelog
 
+2021-08-12 15:06:07 +0930 [4b6cc31](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/4b6cc3176fc4acc3b7dbb954162802af9cbb4c68) - fix(pylint): install the required packages for files being checked  
+2021-08-12 14:49:00 +0930 [936299a](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/936299aefc6eadf9cbfec3152b352b321969cfab) - fix(pylint): fix bug introduced in code quality commit  
+2021-08-12 14:04:32 +0930 [73e061e](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/73e061e649e8fbeee34c6d18cf1f901b394a1f26) - build(pylint): added .pylintrc to exclude some rules  
+2021-08-12 03:32:36 +0000 [389bc08](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/389bc08d7686153fb374aa83d440c35c9b4eac90) - build(version): bump version 0.3.0rc1 → 0.3.0  
 2021-08-11 15:51:45 +0930 [d610562](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/d61056243804728e059b99fce1644a8cc37230bb) - feat(python_linting): added ci job, python linting, code quality and scoring  

python/README.md

@@ -61,6 +61,7 @@ include:
 PyLint:
     variables:
         PYLINT_PATH: "/*/*.py"
+        PYLINT_RC_PATH: "."
     extends:
         - .PyLint
     image: python:3.6-slim
@@ -72,6 +73,7 @@ PyLint:
 | var name | Description |
 |:----:|:----|
 | PYLINT_PATH | *The path you wish the linter to search for python files* |
+| PYLINT_RC_PATH | *The path to your `.pylintrc` file.* |
 
 
 ## Job Workflow

python/requirements.txt

@@ -1,2 +1,4 @@
 pylint==2.9.6
 pylint-gitlab==0.3.0
+gitpython==3.1.18
+commitizen==2.17.13

yaml_lint/CHANGELOG.md

@@ -1,3 +1,4 @@
 # Changelog
 
+2021-08-12 03:32:36 +0000 [389bc08](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/389bc08d7686153fb374aa83d440c35c9b4eac90) - build(version): bump version 0.3.0rc1 → 0.3.0  
 2021-08-11 13:41:42 +0930 [d20a56f](https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/commit/d20a56fa0ca492e3fc2ad7c548fc891cc8ffc8ec) - feat(yaml_lint): Added job yaml lint for checking yaml files