To recreate tox virtual environment (e.g. a dependencies update), you may run `tox -r`
To recreate tox virtual environment (e.g. a dependencies update), you may run `tox -r`
## Implementation
The official documentation of the Arkindex workers is available on [workers.arkindex.org](https://workers.arkindex.org/).
Head over there to understand how they are written and how they interact with Arkindex's API.
## Usage
Each worker is documented in the Markdown file named after its slug, in the `./descriptions/` folder. This documentation is also published on the Arkindex instance along the worker. Learn more about this process in the next section.
## Publication on Arkindex
There are two scenarios:
- one-time publication: follow this section if you want to test the worker before fully integrating it in an Arkindex instance.
- full integration: follow this section when you want to integrate the worker in an Arkindex instance.
### One-time publication
1. Follow the [GitLab documentation](https://docs.gitlab.com/ee/topics/git/clone.html) to clone the worker's repository.
2. Follow the [publication documentation](https://workers.arkindex.org/contents/ship/publication/).
### Full integration
1. Follow the [GitLab documentation](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) to fork the worker's repository.
2. Follow the [integration documentation](https://workers.arkindex.org/contents/ship/publication/#authentication-in-ci).
3. A new version of the worker is published on your instance at every successful pipeline.
