refactor: using tasks directory instead of jobs #23
Conversation
| # {{ cookiecutter.module_name }}/templates/{{ cookiecutter.plugin_name }}/tasks/ | ||
| # and then add it to the MY_INIT_TASKS list. Each task is in the format: | ||
| # ("<service>", ("<path>", "<to>", "<script>", "<template>")) | ||
| MY_INIT_TASKS: list[tuple[str, tuple[str, ...]]] = [ | ||
| # For example, to add LMS initialization steps, you could add the script template at: | ||
| # {{ cookiecutter.module_name }}/templates/{{ cookiecutter.plugin_name }}/jobs/init/lms.sh | ||
| # {{ cookiecutter.module_name }}/templates/{{ cookiecutter.plugin_name }}/tasks/{{ cookiecutter.plugin_name }}/init.sh | ||
| # And then add the line: | ||
| ### ("lms", ("{{ cookiecutter.plugin_name }}", "jobs", "init", "lms.sh")), | ||
| ### ("lms", ("{{ cookiecutter.plugin_name }}", "tasks", "{{ cookiecutter.plugin_name }}", "init.sh")), |
There was a problem hiding this comment.
These changes aren't quite right. While, in general, the structure and names of these files are arbitrary (as long as the scripts are loaded into CLI_DO_COMMANDS), the specific structure that the cookiecutter uses is this:
{{ cookiecutter.module_name }}/templates/{{ cookiecutter.plugin_name }}/tasks/SERVICE_NAME/JOB_NAME.sh
where:
- SERVICE_NAME is the service we're executing the task in. In the commented-out example, that's
lms - JOB_NAME is the name of the job which this task is supporting. In this example, that's
init
There was a problem hiding this comment.
You're right. Do you have any particular service name in mind for this one?
also, should we drop the .sh extension for the job? all of the official plugins use an init file.
There was a problem hiding this comment.
@CodeWithEmad Let's use lms, because that's the most common service in which plugins will need to execute tasks.
also, should we drop the .sh extension for the job? all of the official plugins use an init file.
Good question. I lean dropping the .sh extension since that's what the official plugins do, but I'll leave it up to your discretion.
There was a problem hiding this comment.
I like the .sh extension because it makes it easier to edit the files in the IDE.
There was a problem hiding this comment.
@CodeWithEmad , could you apply this change?
There was a problem hiding this comment.
Oh, I totally forgot about this. Absolutely.
There was a problem hiding this comment.
can you take a look now.
tasks directory in the cookie-cutter is called "jobs", but everywhere is "tasks". This will fix the inconsistency.
CodeWithEmad
force-pushed
the
fix/tasks
branch
from
9ffb5e5 to
5ef6ec7
Compare
There was a problem hiding this comment.
Thanks @CodeWithEmad !
I've made sure that this will be in the soon-to-be-added Changelog, too.
|
Thanks Kyle. |
We are using a simple Changelog.md instead of using scriv because the cookiecutter doesn't have a versioned release process. Discussion at: #22 (comment) Includes a starter entry from: #23
tasks directory in the cookie-cutter is called "jobs", but everywhere is "tasks".
This will fix the inconsistency.