-
Notifications
You must be signed in to change notification settings - Fork 22
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.
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
fix: Remove unused files; add more tests; fix some Make targets and lint #332
Conversation
03610e3
to
297fac7
Compare
297fac7
to
1949d81
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One question
Remove unused files from root of each cookiecutter. These were not actually used as they were not inside the `{{cookiecutter.repo_name}}` dir that would lead to them being included. More information on removals: - `openedx.yaml` removed from xblock cookiecutter root and #334 filed to cover actually adding that tag. (The rest of the file was either redundant with what's in python-template, or obsolete.) - `requirements.txt` was not used in CI or baking - Makefiles were not used. This is unfortunate because the IDA one actually had some useful tests in it. I've moved those to the ci.yml workflow for expediency but they should really be put into the unit tests at some point so that they can be run locally. A lot of the django-app Makefile seemed to have been written while the repo was still in development, and relied on packages that are not installed. For the moved tests to pass, I had to make some fixes to the IDA template: - Add missing `docs` target to Makefile - Add some long-line lint suppression where needed Other improvements: - Remove unused `BAKE_OPTIONS` from root Makefile - Use short version of `BROWSER` script in django-ida Makefile to match other Makefiles - Fix root Makefile so that it actually uses pip-sync rather than just installing it - Update `JWT_PUBLIC_SIGNING_JWK_SET` to be readable and copyable as JSON (as is likely to be done for edx-platform in the ongoing JWK work)
fe38a15
to
d20ec7d
Compare
|
I think |
Filed #339 for fixing this later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Questions and suggestions for changelog
CHANGELOG.rst
Outdated
Added | ||
===== | ||
|
||
- Improve testing for ``cookiecutter-django-ida`` (migrations, quality check, docker image build, docs build) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no docs build :(
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed :-(
Changed | ||
======= | ||
|
||
- Use short version of ``BROWSER`` script in django-ida Makefile to match others |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might also add "removed unused files in django-ida, django-app, and xblock"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added something like this
OK, got one last thing squared away. Ready for re-review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Remove unused files from root of each cookiecutter. These were not actually
used as they were not inside the
{{cookiecutter.repo_name}}
dir thatwould lead to them being included.
More information on removals:
openedx.yaml
removed from xblock cookiecutter root andSet appropriate tags in openedx.yaml #334 filed to cover
actually adding that tag. (The rest of the file was either redundant
with what's in python-template, or obsolete.)
requirements.txt
was not used in CI or bakinghad some useful tests in it. I've moved those to the ci.yml workflow for
expediency but they should really be put into the unit tests at some
point so that they can be run locally. A lot of the django-app Makefile
seemed to have been written while the repo was still in development, and
relied on packages that are not installed.
For the moved tests to pass, I had to make some fixes to the IDA template:
docs
target to Makefile, although it doesn't quite work yet;filed
make docs
is broken on django-ida cookiecutter #339 for fixingthis later.
Other improvements:
BAKE_OPTIONS
from root MakefileBROWSER
script in django-ida Makefile tomatch other Makefiles
installing it
JWT_PUBLIC_SIGNING_JWK_SET
to be readable and copyable as JSON(as is likely to be done for edx-platform in the ongoing JWK work)
fake_translations
Makefile target actually do something.Merge checklist:
Check off if complete or not applicable: