Create & Maintain Salt Extensions

A Copier template that initializes a project structure for developing Salt extension modules.

Why

For individual extension creators, this template allows to quickly get started with developing, testing and releasing new Salt functionality.

For extension maintainers and the salt-extensions organization, it ensures that there is a frictionless way of keeping the necessary boilerplate up to date.

How

For comprehensive instructions on all aspects of Salt extension development with this template, please refer to the user documentation.

Migration from the deprecated tool

Existing projects can be migrated to this template by simply running the creation commands on top of a repo clone. Ensure you additionally pass --vcs-ref=0.0.2 to Copier since this template diverges from the last official release (0.24.0) after that.

git clone https://github.com/salt-extensions/saltext-example
copier copy --trust --vcs-ref=0.0.2 https://github.com/salt-extensions/salt-extension-copier saltext-example

During this process, Copier asks about conflict resolutions. There have likely been several modifications to the boilerplate since the extension was generated, so this can require some attention and could even reintroduce older dependencies. Afterwards, you should update the project to the latest template version.

References

• User documentation for this template
• An overview of modular systems in Salt
• Salt-specific pytest docs
• salt-extensions organization
• Copier docs