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

Confirm that cookiecutter-tutor-plugin works with Olive #12

Closed
kdmccormick opened this issue Oct 12, 2022 · 1 comment · Fixed by #17
Closed

Confirm that cookiecutter-tutor-plugin works with Olive #12

kdmccormick opened this issue Oct 12, 2022 · 1 comment · Fixed by #17
Assignees
@kdmccormick
Labels
release-testing

Comments

@kdmccormick
Copy link
Contributor

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
@kdmccormick kdmccormick self-assigned this Oct 12, 2022
@kdmccormick kdmccormick moved this to To Do - Prioritized for Current Sprint in Axim Engineering Tasks Oct 12, 2022
@kdmccormick kdmccormick changed the title Confirm that the cookiecutter works with Olive Confirm that the Tutor cookiecutter works with Olive Dec 7, 2022
@kdmccormick kdmccormick changed the title Confirm that the Tutor cookiecutter works with Olive Confirm that cookiecutter-tutor-plugin works with Olive Dec 7, 2022
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 kdmccormick mentioned this issue Dec 9, 2022
Merged
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
Copy link
Contributor Author

I followed this test plan and found no issues 👍🏻

I made several improvements & updates that I'd like to merge shortly after Olive is released (#17) but they are not critical for the cookiecutter to work.

Repository owner moved this from In progress to Done in Build-Test-Release Working Group Dec 9, 2022
Repository owner moved this from To Do - Prioritized for Current Sprint to Done in Axim Engineering Tasks Dec 9, 2022
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kdmccormick kdmccormick

Labels
release-testing
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: olive updates, more scaffolding, and basic 'make test' kdmccormick/cookiecutter-tutor-plugin
1 participant
@kdmccormick