saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
salt/tasks
History
Pedro Algarvio b5b6f24367 Only run check-docs on deleted files on CI. 
The hook fails when we delete a module and don't delete the corresponding docs

This is a slow hook to run locally.
2021-03-02 08:42:19 -05:00
..
__init__.py Switch to the remove-import-headers pre-commit hook 2020-10-07 10:46:20 +01:00
docs.py Only run check-docs on deleted files on CI. 2021-03-02 08:42:19 -05:00
filemap.py Add task to check tests/filename_map.yml validity 2020-05-19 10:18:24 -07:00
loader.py Add loader checks although not currently enforcing them 2020-04-23 20:01:05 +01:00
README.md Lay the ground for invoke usage 2020-04-23 18:42:47 +01:00
utils.py Allow running the pre-commit jenkins job in GH Actions 2020-11-30 14:20:56 -07:00

README.md

What is this directory?

This directory contains python scripts which should be called by invoke.

Instead of having several multi-purpose python scripts scatered through multiple paths in the salt code base, we will now concentrate them under an invoke task.

Calling Invoke

Invoke can be called in the following ways.

Installed system-wide

If invoke is installed system-wide, be sure you also have blessings installed if you want coloured output, although it's not a hard requirement.

inv docs.check

Using Nox

Since salt already uses nox, and nox manages virtual environments and respective requirements, calling invoke is as simple as:

nox -e invoke -- docs.check