Skip to content
Snippets Groups Projects
Verified Commit a47bd47e authored by Yoann Schneider's avatar Yoann Schneider :tennis:
Browse files

Update YAML template page

parent 8358068b
No related branches found
No related tags found
1 merge request!550Update YAML template page
Pipeline #174115 passed
...@@ -9,18 +9,14 @@ package, a Docker build, with the best development practices: ...@@ -9,18 +9,14 @@ package, a Docker build, with the best development practices:
with this repository. with this repository.
To learn more about this file, see [YAML configuration](../implem/configure/yaml.md). To learn more about this file, see [YAML configuration](../implem/configure/yaml.md).
`.cookiecutter.yaml` `.cookiecutter.json`
: YAML file that stores the options you defined when creating a new worker. : JSON file that stores the options you defined when creating a new worker.
This file can be reused to [fetch template updates][template-updates]. This file can be reused to [fetch template updates][template-updates].
`.dockerignore` `.dockerignore`
: Lists which files to exclude from the Docker build context. : Lists which files to exclude from the Docker build context.
For more information, see the [Docker documentation][dockerignore]. For more information, see the [Docker documentation][dockerignore].
`.flake8`
: Specifies configuration options for the Flake8 linter.
For more information, see the [Flake8 documentation][flake8].
`.gitignore` `.gitignore`
: Lists which files to exclude from Git versioning. : Lists which files to exclude from Git versioning.
For more information, see the [Git docs][gitignore]. For more information, see the [Git docs][gitignore].
...@@ -30,10 +26,6 @@ package, a Docker build, with the best development practices: ...@@ -30,10 +26,6 @@ package, a Docker build, with the best development practices:
To learn more about the configuration we provide, see To learn more about the configuration we provide, see
[GitLab Continuous Integration for workers](../implem/test/ci.md). [GitLab Continuous Integration for workers](../implem/test/ci.md).
`.isort.cfg`
: Configures the automatic Python import sorting rules.
For more information, see the [isort docs][isort].
`.pre-commit.config.yaml` `.pre-commit.config.yaml`
: Configures the [pre-commit hook](create.md#activating-the-pre-commit-hook). : Configures the [pre-commit hook](create.md#activating-the-pre-commit-hook).
...@@ -42,6 +34,10 @@ package, a Docker build, with the best development practices: ...@@ -42,6 +34,10 @@ package, a Docker build, with the best development practices:
You can change the instructions in this file to update the image to the needs You can change the instructions in this file to update the image to the needs
of your worker, for example to install system dependencies. of your worker, for example to install system dependencies.
`Makefile`
: Mostly used to build releases of a worker more easily.
For more information, see [Maintaining a worker][maintenance].
`tox.ini` `tox.ini`
: Configures the Python unit test runner. : Configures the Python unit test runner.
For more information, see the [tox docs][tox]. For more information, see the [tox docs][tox].
...@@ -55,27 +51,24 @@ package, a Docker build, with the best development practices: ...@@ -55,27 +51,24 @@ package, a Docker build, with the best development practices:
`tests/test_worker.py` `tests/test_worker.py`
: An example unit test file. : An example unit test file.
For more information, see [Writing tests for your worker][tests].
<!-- `descriptions/[__slug].md`
TODO: For more information, see [Writing tests for your worker](tests). : Describe your worker in this file. The file should be named after its slug.
--> The content should be valid Markdown. It will be published and visible on Arkindex.
`worker_[__module]/__init__.py` `worker_[__module]/__init__.py`
: Declares the folder as a Python package. : Declares the folder as a Python package.
`worker_[__module]/worker.py` `worker_[__module]/worker.py`
: The core part of the worker. This is where you can write code that processes : The core part of the worker. This is where you can write code that processes
Arkindex elements. Arkindex elements. For more information, see [Implementing an Elements worker][implement-elements].
<!-- TODO:
For more information, see
[Implementing a Machine Learning worker](implement.md).
-->
[base-worker]: https://gitlab.teklia.com/workers/base-worker/ [base-worker]: https://gitlab.teklia.com/workers/base-worker/
[dockerignore]: https://docs.docker.com/engine/reference/builder/#dockerignore-file [dockerignore]: https://docs.docker.com/engine/reference/builder/#dockerignore-file
[flake8]: https://flake8.pycqa.org/en/latest/user/configuration.html
[gitignore]: https://git-scm.com/docs/gitignore [gitignore]: https://git-scm.com/docs/gitignore
[isort]: https://pycqa.github.io/isort/docs/configuration/config_files/
[template-updates]: maintenance.md#updating-the-template [template-updates]: maintenance.md#updating-the-template
[tests]: ../implem/test/index.md
[implement-elements]: ../implem/index.md
[maintenance]: ../init/maintenance.md
[tox]: https://tox.readthedocs.io/en/latest/config.html [tox]: https://tox.readthedocs.io/en/latest/config.html
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment