Refactor pipelines to use new scripts

Author: 31ch

Jenkinsfile

@@ -24,22 +24,21 @@ pipeline {
     stages {
         stage('Cleanup') {
             steps {
-                sh 'rm -rf dist build docs/_build'
+                sh 'rm -rf dist build'
             }
         }
         stage('Build documentation') {
             steps {
-                sh 'pip install -e .' // required for python_training_project.version
-                sh 'cd docs && pipenv run make html'
+                sh './tools/build-docs.sh'
                 archiveArtifacts(
-                    artifacts: 'docs/_build/html/**',
+                    artifacts: 'build/html/**',
                     onlyIfSuccessful: true
                 )
                 publishHTML([
                     allowMissing: false,
                     alwaysLinkToLastBuild: false,
                     keepAll: false,
-                    reportDir: 'docs/_build/html/',
+                    reportDir: 'build/html/',
                     reportFiles: 'index.html',
                     reportName: 'Documentation',
                     reportTitles: '',
@@ -49,23 +48,17 @@ pipeline {
         }
         stage('Build Python package') {
             steps {
-                sh 'python -m build --wheel'
+                sh './tools/build-package.sh'
                 archiveArtifacts(
-                    artifacts: 'dist/**/*.whl',
+                    artifacts: 'dist/*.whl',
                     onlyIfSuccessful: true
                 )
             }
         }
         stage('Static code analysis') {
             steps {
-                warnError('flake8 issues found') {
-                    sh 'flake8 src/python_training_project --format=pylint > flake8.log'
-                }
-                warnError('pylint issues found') {
-                    sh 'pylint src/python_training_project --msg-template="{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})" > pylint.log'
-                }
-                warnError('mypy issues found') {
-                    sh 'mypy src/python_training_project > mypy.log'
+                warnError('lint issues found') {
+                    sh './tools/lint-package.sh'
                 }
                 recordIssues(
                     sourceCodeRetention: 'LAST_BUILD',
@@ -76,24 +69,23 @@ pipeline {
                             lowTags: 'HACK',
                             normalTags: 'TODO'
                         ),
-                        flake8(pattern: 'flake8.log'),
-                        pyLint(pattern: 'pylint.log'),
-                        myPy(pattern: 'mypy.log')
+                        flake8(pattern: 'build/flake8.txt'),
+                        pyLint(pattern: 'build/pylint.txt'),
+                        myPy(pattern: 'build/mypy.txt')
                     ]
                 )
             }
         }
         stage('Test Python package') {
             steps {
-                sh 'pip install -e .'
-                sh 'pytest'
+                sh './tools/test-package.sh'
                 junit(
-                    testResults: 'report.xml'
+                    testResults: 'build/test-report.xml'
                 )
                 recordCoverage(
                     tools: [
-                        [parser: 'JUNIT', pattern: 'report.xml'],
-                        [parser: 'COBERTURA', pattern: 'coverage.xml']
+                        [parser: 'JUNIT', pattern: 'build/test-report.xml'],
+                        [parser: 'COBERTURA', pattern: 'build/test-coverage.xml']
                     ]
                 )
             }

Jenkinsfile.groovy

@@ -15,42 +15,35 @@ node {
     }
     customImage.inside('--net="jenkins_default"') { // required for accessing the Gitea server
         stage('Cleanup') {
-            sh 'rm -rf dist build docs/_build'
+            sh 'rm -rf dist build'
         }
         stage('Build documentation') {
-            sh 'pip install -e .' // required for python_training_project.version
-            sh 'cd docs && pipenv run make html'
+            sh './tools/build-docs.sh'
             archiveArtifacts(
-                artifacts: 'docs/_build/html/**',
+                artifacts: 'build/html/**',
                 onlyIfSuccessful: true
             )
             publishHTML([
                 allowMissing: false,
                 alwaysLinkToLastBuild: false,
                 keepAll: false,
-                reportDir: 'docs/_build/html/',
+                reportDir: 'build/html/',
                 reportFiles: 'index.html',
                 reportName: 'Documentation',
                 reportTitles: '',
                 useWrapperFileDirectly: true
             ])
         }
         stage('Build Python package') {
-            sh 'python -m build --wheel'
+            sh './tools/build-package.sh'
             archiveArtifacts(
-                artifacts: 'dist/**/*.whl',
+                artifacts: 'dist/*.whl',
                 onlyIfSuccessful: true
             )
         }
         stage('Static code analysis') {
-            warnError('flake8 issues found') {
-                sh 'flake8 src/python_training_project --format=pylint > flake8.log'
-            }
-            warnError('pylint issues found') {
-                sh 'pylint --msg-template="{path}:{line}: [{msg_id}, {obj}] {msg} ({symbol})" src/python_training_project > pylint.log'
-            }
-            warnError('mypy issues found') {
-                sh 'mypy src/python_training_project > mypy.log'
+            warnError('lint issues found') {
+                sh './tools/lint-package.sh'
             }
             recordIssues(
                 sourceCodeRetention: 'LAST_BUILD',
@@ -61,22 +54,22 @@ node {
                         lowTags: 'HACK',
                         normalTags: 'TODO'
                     ),
-                    flake8(pattern: 'flake8.log'),
-                    pyLint(pattern: 'pylint.log'),
-                    myPy(pattern: 'mypy.log')
+                    flake8(pattern: 'build/flake8.txt'),
+                    pyLint(pattern: 'build/pylint.txt'),
+                    myPy(pattern: 'build/mypy.txt')
                 ]
             )
         }
         stage('Test Python package') {
             sh 'pip install -e .'
             sh 'pytest'
             junit(
-                testResults: 'report.xml'
+                testResults: 'build/test-report.xml'
             )
             recordCoverage(
                 tools: [
-                    [parser: 'JUNIT', pattern: 'report.xml'],
-                    [parser: 'COBERTURA', pattern: 'coverage.xml']
+                    [parser: 'JUNIT', pattern: 'build/test-report.xml'],
+                    [parser: 'COBERTURA', pattern: 'build/test-coverage.xml']
                 ]
             )
         }

docs/Makefile

@@ -7,7 +7,7 @@ SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SPHINXAPIDOC  ?= sphinx-apidoc
 SOURCEDIR     = .
-BUILDDIR      = _build
+BUILDDIR      = ../build
 PACKAGEDIR	  = ../src
 
 # Put it first so that "make" without argument is like "make help".

pyproject.toml

@@ -37,7 +37,7 @@ write_to = "src/python_training_project/version.py"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = "--cov --cov-report term --cov-report xml --junitxml=report.xml"
+addopts = "--cov --cov-report term --cov-report xml --junitxml=build/test-report.xml"
 testpaths = [
     "tests",
 ]
@@ -50,4 +50,8 @@ omit = [
     "*/version.py",
     "tests/*"
 ]
+
+[tool.coverage.xml]
+output = "build/test-coverage.xml"
+
 source_pkgs = ["python_training_project"]