Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include basic CI setup for new plugins #7

Closed
kdmccormick opened this issue Jun 6, 2022 · 3 comments · Fixed by #29
Closed

Include basic CI setup for new plugins #7

kdmccormick opened this issue Jun 6, 2022 · 3 comments · Fixed by #29
Labels
enhancement New feature or request

Comments

@kdmccormick
Copy link
Contributor

kdmccormick commented Jun 6, 2022 •
edited

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
@kdmccormick kdmccormick mentioned this issue Jun 6, 2022
Closed
@fghaas
Copy link

fghaas commented Jun 24, 2022 •
edited

@kdmccormick, feel free to pull from the for-kyle branch in my fork and work from there. I haven't done any real work on it except take the commits from #2 that match your bullets, plus rebase the branch on current master, but maybe it's useful.

@kdmccormick
Copy link
Contributor Author

Excellent, thank you!

@kdmccormick kdmccormick mentioned this issue Nov 14, 2022
Closed
kdmccormick added a commit to kdmccormick/cookiecutter-tutor-plugin that referenced this issue Dec 7, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
c1fd177 
* Replace COMMANDS_INIT (which is deprecated in Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in Olive).
  Closes overhangio#15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of overhangio#7.
@kdmccormick kdmccormick mentioned this issue Dec 7, 2022
Merged
kdmccormick added a commit to kdmccormick/cookiecutter-tutor-plugin that referenced this issue Dec 7, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
67c01eb 
* Replace COMMANDS_INIT (which is deprecated in Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in Olive).
  Closes overhangio#15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of overhangio#7.
kdmccormick added a commit to kdmccormick/cookiecutter-tutor-plugin that referenced this issue Dec 7, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
239e40d 
* Replace COMMANDS_INIT (which is deprecated in Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in Olive).
  Closes overhangio#15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Un-comment as much of the image management block as possible
  in order to help avoid instances of syntactically invalid commented-out
  code such as: overhangio#16

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of overhangio#7.
kdmccormick added a commit to kdmccormick/cookiecutter-tutor-plugin that referenced this issue Dec 9, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
14038ae 
* Confirm that cookiecutter generates a plugin that is compatible
  with the Tutor v15 (and Open edX Olive).

* Replace COMMANDS_INIT (which is deprecated in v15/Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in v15/Olive).
  Closes overhangio#15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in v15/Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Un-comment as much of the image management block as possible
  in order to help avoid instances of syntactically invalid commented-out
  code such as: overhangio#16

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of overhangio#7.
kdmccormick added a commit to kdmccormick/cookiecutter-tutor-plugin that referenced this issue Dec 9, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
0395834 
* Confirm that cookiecutter generates a plugin that is compatible
  with the Tutor v15 (and Open edX Olive).
  Closes overhangio#12.

* Replace COMMANDS_INIT (which is deprecated in v15/Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in v15/Olive).
  Closes overhangio#15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in v15/Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Un-comment as much of the image management block as possible
  in order to help avoid instances of syntactically invalid commented-out
  code such as: overhangio#16

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of overhangio#7.
kdmccormick added a commit to kdmccormick/cookiecutter-tutor-plugin that referenced this issue Dec 9, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
8ef7e17 
* Confirm that cookiecutter generates a plugin that is compatible
  with the Tutor v15 (and Open edX Olive).
  Closes overhangio#12.

* Replace COMMANDS_INIT (which is deprecated in v15/Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in v15/Olive).
  Closes overhangio#15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in v15/Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Un-comment as much of the image management block as possible
  in order to help avoid instances of syntactically invalid commented-out
  code such as: overhangio#16

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of overhangio#7.
kdmccormick added a commit to kdmccormick/cookiecutter-tutor-plugin that referenced this issue Dec 9, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
4338891 
* Confirm that cookiecutter generates a plugin that is compatible
  with the Tutor v15 (and Open edX Olive).
  Closes overhangio#12.

* Replace COMMANDS_INIT (which is deprecated in v15/Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in v15/Olive).
  Closes overhangio#15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in v15/Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Un-comment as much of the image management block as possible
  in order to help avoid instances of syntactically invalid commented-out
  code such as: overhangio#16

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of overhangio#7.
kdmccormick added a commit to kdmccormick/cookiecutter-tutor-plugin that referenced this issue Dec 9, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
d6ea727 
* Confirm that cookiecutter generates a plugin that is compatible
  with the Tutor v15 (and Open edX Olive).
  Closes overhangio#12.

* Replace COMMANDS_INIT (which is deprecated in v15/Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in v15/Olive).
  Closes overhangio#15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in v15/Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Un-comment as much of the image management block as possible
  in order to help avoid instances of syntactically invalid commented-out
  code such as: overhangio#16

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of overhangio#7.
kdmccormick added a commit that referenced this issue Dec 16, 2022
@kdmccormick
feat: olive updates, more scaffolding, and basic 'make test'
2ee5035 
* Confirm that cookiecutter generates a plugin that is compatible
  with the Tutor v15 (and Open edX Olive).
  Closes #12.

* Replace COMMANDS_INIT (which is deprecated in v15/Olive) with
  equivalent usage of CLI_DO_INIT_TASKS (which is new in v15/Olive).
  Closes #15.

* Add boilerplate & explanation for CLI_DO_COMMANDS (new in v15/Olive),
  include a dummy example `tutor local do say-hi` job.

* Add boilerplate and explanation for CLI_COMMANDS, including
  a dummy example `tutor myplugin print-repo` command.

* Un-comment as much of the image management block as possible
  in order to help avoid instances of syntactically invalid commented-out
  code such as: #16

* Add Makefile to both cookiecutter root as well as generated plugin,
  providing make rules `test`, `test-format`, `test-lint`, and
  `test-types`. They are not yet run in CI.
  Part of #7.
@kdmccormick kdmccormick mentioned this issue Mar 20, 2023
Closed
@kdmccormick kdmccormick added the enhancement New feature or request label Jun 2, 2023
@CodeWithEmad
Copy link
Collaborator

Right now, all official tutor plugins have a simple test.yml which runs make test. if that's enough, I can include that in our cookiecutter.
@kdmccormick

@CodeWithEmad CodeWithEmad mentioned this issue Dec 26, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
No open projects
Tutor DevEnv Adoption
Status: 🚀 Closed
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

New cookiecutter CodeWithEmad/cookiecutter-tutor-plugin
3 participants
@fghaas @kdmccormick @CodeWithEmad