ci: Add pyDocStyle check

UIUCLibrary · Oct 11, 2023 · c87a9f5 · c87a9f5
1 parent 07d18e8
commit c87a9f5
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -58,6 +58,23 @@ pipeline {
                         }
                         stage('Run Checks'){
                             parallel{
+                                stage('pyDocStyle'){
+                                    steps{
+                                        catchError(buildResult: 'SUCCESS', message: 'Did not pass all pyDocStyle tests', stageResult: 'UNSTABLE') {
+                                            sh(
+                                                label: 'Run pydocstyle',
+                                                script: '''mkdir -p reports
+                                                           pydocstyle speedwagon > reports/pydocstyle-report.txt
+                                                           '''
+                                            )
+                                        }
+                                    }
+                                    post {
+                                        always{
+                                            recordIssues(tools: [pyDocStyle(pattern: 'reports/pydocstyle-report.txt')])
+                                        }
+                                    }
+                                }
                                 stage('PyTest'){
                                     steps{
                                         catchError(buildResult: 'UNSTABLE', message: 'Did not pass all pytest tests', stageResult: 'UNSTABLE') {

diff --git a/requirements/requirements-ci-freeze.txt b/requirements/requirements-ci-freeze.txt
@@ -19,7 +19,7 @@ Jinja2==3.1.2
 lxml==4.9.3
 MarkupSafe==2.1.3
 mccabe==0.7.0
-mypy==1.5.1
+mypy==1.6.0
 mypy-extensions==1.0.0
 node-semver==0.6.1
 packaging==23.2
@@ -29,6 +29,7 @@ pluggy==1.3.0
 pluginbase==1.0.1
 pybind11==2.11.1
 pycodestyle==2.11.0
+pydocstyle==6.3.0
 pyflakes==3.1.0
 Pygments==2.16.1
 PyJWT==2.8.0

diff --git a/requirements/requirements-dev.txt b/requirements/requirements-dev.txt
@@ -5,3 +5,4 @@ mypy
 pytest
 pylint
 sphinx
+pydocstyle