Docker development environment improvements #180
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jathanism
suggested changes
Mar 23, 2021
There was a problem hiding this comment.
Love this overall. I would like to see the tasks that have flags be documented using the help argument to the @task() decorator and remove the extra context and flag documentation from the docstrings.
jathanism
approved these changes
Mar 24, 2021
| @task( | ||
| help={ | ||
| "force_rm": "Always remove intermediate containers", | ||
| "cache": "Whether to use Docker's cache when building the image (defaults to enabled)", |
There was a problem hiding this comment.
% invoke build --help
Usage: inv[oke] [--core-opts] build [--options] [other tasks here ...]
Docstring:
Build Nautobot docker image.
Options:
-c, --[no-]cache Whether to use Docker's cache when building the image (defaults to enabled)
-f, --force-rm Always remove intermediate containers
🤵
This was referenced Mar 24, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #163 (in a roundabout way)
docker-entrypoint.sh(which is extraneous at best, and downright confusing when runninginvoke createsuperuser)--python-verargument from all invoke tasks and document in the developer guide thatexport PYTHON_VER=3.xis the way to set a non-default Python version for the Docker Compose workflow.docker_compose()helper function intasks.pyand use it to cut down boilerplate.--nocacheand--forcermoptions to thebuildtask.invoke restarttask.coverage-runandcoverage-reporttasks tounittestandunittest-coveragerespectively.--keepdboption to theunittesttaskdocker-entrypoint.shwhen running unit tests and linters (saving container startup time).