Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
B
Base Worker
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Workers
Base Worker
Commits
a47bd47e
Verified
Commit
a47bd47e
authored
9 months ago
by
Yoann Schneider
Browse files
Options
Downloads
Patches
Plain Diff
Update YAML template page
parent
8358068b
No related branches found
Branches containing commit
Tags
0.1.9
Tags containing commit
1 merge request
!550
Update YAML template page
Pipeline
#174115
passed
9 months ago
Stage: release
Changes
1
Pipelines
4
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/contents/init/template-structure.md
+14
-21
14 additions, 21 deletions
docs/contents/init/template-structure.md
with
14 additions
and
21 deletions
docs/contents/init/template-structure.md
+
14
−
21
View file @
a47bd47e
...
...
@@ -9,18 +9,14 @@ package, a Docker build, with the best development practices:
with this repository.
To learn more about this file, see
[
YAML configuration
](
../implem/configure/yaml.md
)
.
`.cookiecutter.
yaml
`
:
YAML
file that stores the options you defined when creating a new worker.
`.cookiecutter.
json
`
:
JSON
file that stores the options you defined when creating a new worker.
This file can be reused to
[
fetch template updates
][
template-updates
]
.
`.dockerignore`
: Lists which files to exclude from the Docker build context.
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`
: Lists which files to exclude from Git versioning.
For more information, see the
[
Git docs
][
gitignore
]
.
...
...
@@ -30,10 +26,6 @@ package, a Docker build, with the best development practices:
To learn more about the configuration we provide, see
[
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`
: 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:
You can change the instructions in this file to update the image to the needs
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`
: Configures the Python unit test runner.
For more information, see the
[
tox docs
][
tox
]
.
...
...
@@ -55,27 +51,24 @@ package, a Docker build, with the best development practices:
`tests/test_worker.py`
: An example unit test file.
For more information, see
[
Writing tests for your worker
][
tests
]
.
<!--
TODO: Fo
r
m
or
e information, see
[
Writing tests for your worker
](
tests
)
.
-->
`descriptions/[__slug].md`
: Describe you
r
w
or
ker 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`
: Declares the folder as a Python package.
`worker_[__module]/worker.py`
: The core part of the worker. This is where you can write code that processes
Arkindex elements.
<!-- TODO:
For more information, see
[
Implementing a Machine Learning worker
](
implement.md
)
.
-->
Arkindex elements. For more information, see
[
Implementing an Elements worker
][
implement-elements
]
.
[
base-worker
]:
https://gitlab.teklia.com/workers/base-worker/
[
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
[
isort
]:
https://pycqa.github.io/isort/docs/configuration/config_files/
[
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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment