Commit e70e6a9d authored by GridexX's avatar GridexX
Browse files

feat(jobs): update images for pylint and sphinx 



Signed-off-by: default avatarGridexX <arsene582@gmail.com>
parent 84cd5956

jobs/pylint/CHANGELOG.md

+3 −0
Original line number Diff line number Diff line 
# Changelog

All notable changes to this job will be documented in this file.



## [1.2.0] - 2023-03-03

* Bump `IMAGE_TAG` to 3.11-alpine

  

## [1.1.1] - 2023-02-28

* Fix broken documentation links

jobs/pylint/README.md

+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ This job will use the tool [pylint](https://pylint.pycqa.org/en/latest/intro.htm 
| `PYLINT_OPTIONS` | [Additional options](https://pylint.pycqa.org/en/latest/user_guide/run.html) for `pylint` | `` |

| `PYLINT_OUTPUT` | Output file | `report_pylint.xml` |

| `PYLINT_EXIT_ZERO` | Returns a non-zero status code. If the option is specified, and Pylint runs successfully, it will exit with 0 regardless of the number of lint issues detected. | `true` |

| `IMAGE_TAG` | The default tag for the docker image | `3.10-buster`  |

| `IMAGE_TAG` | The default tag for the docker image | `3.11-alpine`  |





## Author

jobs/pylint/pylint.yml

+1 −1
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ pylint: 
    PYLINT_OPTIONS: ""

    PYLINT_OUTPUT: "report_pylint.xml"

    PYLINT_EXIT_ZERO: "true"

    IMAGE_TAG: "3.10-buster"

    IMAGE_TAG: "3.11-alpine"

  script:

    - cd $PROJECT_ROOT

    - pip install pylint pylint_junit

jobs/sphinx_build/CHANGELOG.md

+4 −0
Original line number Diff line number Diff line 
# Changelog

All notable changes to this job will be documented in this file.



## [0.3.0] - 2023-03-03

* Bump `IMAGE_TAG` to 3.11-alpine

* Change default value of `SPHINX_SOURCE` to `docs/source/`



## [0.2.1] - 2023-02-28

* Fix broken documentation links

jobs/sphinx_build/README.md

+2 −2
Original line number Diff line number Diff line
@@ -18,13 +18,13 @@ 
| `PROJECT_ROOT` | Relative to root of your repository, it is the path to your project. | `.` |

| `SPHINX_THEME` | HTML theme builder to download, sphinx comes with [builtin themes](https://www.sphinx-doc.org/en/master/usage/theming.html#builtin-themes){:target="_blank"}. Check this [site](https://sphinx-themes.org/){:target="_blank"} to download third party themes | ` ` |

| `SPHINX_BUILDER` | Builder used for site generation, check the [builder list](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#options){:target="_blank"}.| `html` |

| `SPHINX_SOURCE` | Directory name of the source files to build the Sphinx website.  | `docs/` |

| `SPHINX_SOURCE` | Directory name of the source files to build the Sphinx website.  | `docs/source/` |

| `SPHINX_OUTPUT` | Output directory path produced by the `sphinx-build`. | `website_build/` |

| `SPHINX_OPTIONS` | Possibility to add more [options](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#options){:target="_blank"} into the `sphinx-build` command. | ` ` |

| `APIDOC_SOURCE` | Directory name of the source files to build the Sphinx sources automatically, check the `sphinx-apidoc` [documentation](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html){:target="_blank"} to learn more. Leave this variable empty if you don't want to execute this command. | ` ` |

| `APIDOC_OUTPUT` | Output directory path produced by the `sphinx-apidoc`. | `docs/reference/source/` |

| `APIDOC_OPTIONS` | Possibility to add more [options](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html#options){:target="_blank"} into the `sphinx-apidoc` command. | ` ` |

| `IMAGE_TAG` | The default tag for the docker image | `3.10-buster`  |

| `IMAGE_TAG` | The default tag for the docker image | `3.11-alpine`  |