FlyteCTL Contribution Guide¶
First off, thank you for thinking about contributing! Below you’ll find instructions that will hopefully guide you through how to contribute to, fix, and improve FlyteCTL.
📝 Contribute to Documentation¶
Docs are generated using Sphinx and are available at [flytectl.rtfd.io](https://flytectl.rtfd.io).
To update the documentation, follow these steps:
Install the requirements by running
pip install -r doc-requirements.txtin the root folder
Make modifications in the cmd folder
make gendocsfrom within the docs folder
Open html files produced by Sphinx in your browser to verify if the changes look as expected (html files can be found in the
💻 Contribute Code¶
make compilein the root directory to compile the code
Set up a local cluster by running
./bin/flytectl sandbox startin the root directory
flytectl get projectto see if things are working
Run the command you want to test in the terminal
If you want to update the command (add additional options, change existing options, etc.):
Navigate to cmd directory
Each sub-directory points to a command, for example,
flytectl create ...
Here are the directories you can navigate to:
flytectl config ...
Common package for all commands; has root flags
flytectl configuration ...
Command to validate/generate flytectl config
flytectl create ...
Command to create a project/execution
flytectl delete ...
Command to abort an execution and delete resource attributes
flytectl get ...
Command to get a task/workflow/launchplan/execution/project/resource’s-attributes
flytectl register ...
Command to register a task/workflow/launchplan
flytectl sandbox ...
Command to interact with sandbox
flytectl update ...
Command to update a project/launchplan/resource’s-attributes
flytectl upgrade ...
Command to upgrade/rollback FlyteCTL version
flytectl version ...
Command to fetch FlyteCTL version
Find all FlyteCTL commands on the Nouns page.
Run appropriate tests to test the changes by running
go test ./... -race -coverprofile=coverage.txt -covermode=atomic -vin the root directory