overhangio / cookiecutter-tutor-plugin Goto Github PK

Test steps:

• Check out Tutor's olive branch
• Run quickstart
• Use this repo to generate a new plugin
• Fill in the cookie-cut file: add a setting, override a setting, implement a patch, add a template, etc
• Install and enable the plugin
• tutor config save
• Confirm that the plugin affects the rendered env as expected
• tutor local start
• Confirm that the plugin affects the Open edX instance as expected

AC

• Check out some of the Nutmeg upgrades that other plugins have completed.
• Reflect any relevant patterns back in the cookiecutter.

Once overhangio/tutor#738 merges, update the cookiecutter to use CLI_DO_INIT_TASKS instead of COMMANDS_INIT.

Test steps:

• Check out Tutor's palm branch
• Run launch
• Use this repo to generate a new plugin
• Fill in the cookie-cut file: add a setting, override a setting, implement a patch, add a template, etc
• Install and enable the plugin
• tutor config save
• Confirm that the plugin affects the rendered env as expected
• tutor local start
• Confirm that the plugin affects the Open edX instance as expected

I get an error when trying to create a plugin:

Unable to create file '.github/workflows/test.yml'
Error message: 'matrix' is undefined

Maybe cookiecutter is mistaking the curly brackets in .github/workflows/test.yml?

It's curious that I'm setting [12/12] Include continuous integration files for GitHub CI (y/n) (y): n and yet it tries to create the workflow file.

After playing around with the plugin cookiecutter, I noticed that the .github directory is always removed, even if include_ci equals "y".

Inspired by @fghaas 's work on #2. It would be good if the cookiecutter included a tox.ini and GHA workflow(s) for things like:

• linting
• style checking
• type checking
• testing that the plugin can be enabled and makes it through tutor config save
• testing custom CLI commands, if relevant

Ensure cookiecutter-tutor-plugin codebase is compatible with Python 3.12

See overhangio/tutor#1004 for the context.

The need to migrate custom commands to v1 appeared while migrating the xqueue plugin: overhangio/tutor-xqueue#8 (comment)

The migration guide to v1 should include instructions on how to migrate the commands object.

I've created a basic plugin with templates and patches and installed it next to a quince setup. everything worked fine.
@regisb @kdmccormick I want to know your opinion about having some sort of dummy plugin that uses all of tutor's features. we can always use that to make sure cookie-cutter works with tutor.

Example to follow: overhangio/tutor-ecommerce#39