- added new catalog-info field
openedx.org/release - removed openedx.yaml file
- Added python3.11 support.
- Add selfcheck target to Makefile
- Remove incorrect build step from xblock ci template
- Fix docstrings
- Add a unit test so coverage can run
- Remove pii_check from xblock cookiecutter
- Move the
.readthedocs.ymlfile to.readthedocs.yaml - Update
.readthedocs.yamlwith new config settings and removed older settings that are no longer supported. - Update
.readthedocs.yamlso that by default we fail on Sphinx warnings. These warnings generally point out important documentation functionality issues like missing docs or broken links.
- Changed "Getting Started" section in templated README to link to new Open edX documentation page, and renamed to "Getting Started with Development" to clarify purpose.
- Renamed
prod_requirementsMaketarget in new IDAs toproduction-requirements.
- Ensure tox runs locally with new requirements by deleting .tox folder before
running
make requirementsormake dev_requirements.
- In setup.py, support advertising constraints on packages with multiple extras
- Fail packaging if requirements are named differently in different places or have different extras listed
- Added: When a repo is made outside of the openedx GitHub organization, the post hook tells the user to go find changes that need to be made.
- Update mysql docker image from 5.6 to 8.0 to use the newest LTS version of the mysql server
- Include
pkg-configin apt-installed packages in IDA Dockerfile, allowing upgrade to mysqlclient 2.2.0
- Fix various quality, doc build, and test failures in the python-library cookiecutter
- Reduce the change of regressions by ensuring that
make test-allis run on the python-library output as part of the cookiecutter repo's own unit tests
- The user is prompted for the GitHub organization that will host the repo.
- Test directories in generated repos are no longer omitted from coverage measurement.
- The author name and author email information requested by the cookiecutter is now used in the generated setup.py. The defaults have also changed from edX-centric to ones centered in the Open edX world.
- Corrected all security email addresses to security@openedx.org.
- Add missing
docsandfake_translationsMakefile targets tocookiecutter-django-idaand suppressed long-line lint as appropriate. (The docs target is still partly broken, though.) - Removed unused and distracting files in various cookiecutters (no effect on output)
- Use short version of
BROWSERscript in django-ida Makefile to match others
- Improve testing for
cookiecutter-django-ida(migrations, quality check, docker image build, translations)
- Correct .coveragerc
omitfile paths to properly specify directories.
- Ensure
cookiecutter-django-idaMakefile installs pip-tools before trying to use pip-sync in requirements targets (#317) - Add
piptoolstarget tocookiecutter-xblockMakefile for consistency
- Removed
clean_pycryptofrom IDA cookiecutter Makefile
- Switched to
sphinx-book-themeas the new standard theme across all Open edX repos. See https://github.com/openedx/edx-sphinx-theme/issues/184 for more details.
- Corrected the punctuation of changelog entries.
- Removed
default_app_configfrom django-app cookiecutter output's dunder-init file (deprecated in Django 3, removed in Django 4)
- Updated upgrade-python-requirements.yml GitHub Action to latest from upgrade-python-requirements.yml template.
- Remove deprecated codecov CI package in requirements/ci.in
- Added linebreaks to root urls.py docstring for cookiecutter-django-ida to squash Sphinx error.
- Fixed cookiecutter-django-ida .coveragerc file so it references project_name, not source_name.
- Fixed .github/workflow/ci.yml so it uploads coverage reports in the tox env that the coverage files are generated in.
- Updated generated PR templates to be as small as possible, with checklists customized to repo type
- Move
check-reserved-keywords.ymlto correct place for IDA. (Was not ending up in output at all since #215.)
- Added explicit PLACEHOLDER and TODO markers to the README to make clear where edits are needed.
- Re-ruled all the RST files to match the new docs guidance.
- Update template README.rst to match OEP-55 Guidelines
- Update the cookiecutter for XBlocks to use the supported Docker image rather than a legacy, unsupported fork
- Standardised the Requirements file structure in all templates.
- Only run
make check_keywordsfor IDAs, not all repos - Ensure django-app unit tests will work, and test this in cookiecutter's own CI
- Removed redundant New Relic agent injection in Makefile
- Removed references to now unsupported Travis CI
- Fix or remove
tagsrepo metadata in several templates; remove deprecatednickfrom openedx.yaml (see OEP-2) - Remove extraneous period after short description
- Move short description to top of readme
- Use project name, not repo name, for package name in setup.py
- Change Django documentation and setup.py references from 2.2 to 3.2
- Used newer, non-deprecated name for middleware to add custom attributes to requests from edx-drf-extensions
- Used newer, non-deprecated name for metrics monitoring middleware from edx-django-utils
- Added several more monitoring middlewares for IDAs
- Fixed an issue with default config for JWT auth for new IDAs.
- Removed redundant New Relic agent injection in Dockerfile
- Added Support for Django40
- Removed Support for Django22, 30, 31
- Makefile created for django-ida now interpolates repo_name into dockerhub commands.
- Added GitHub Actions to the python-template cookiecutter so that all cookiecutters will make repos that check for conventional commits.
- Include system checks for Django apps in order to catch mismatches between model fields and Django admin.
- Update cookiecutters so that sphinx warnings are treated as errors.
- Django-IDA Dockerfiles
- Testing Dockerfiles into make test for Django-IDA
- Django-IDA Dockerfile now uses ubuntu focal
- Fixed django module documentation by using proper django settings.
- Added "Edit on Github" button to new project's ReadTheDocs.
- Add a typical development workflow to the generated README
- All projects (including top level) use Python 3.8 and Django 2.2
- Fix Read the Docs config to point to the correct config file.
requirements/docs.txtshould berequirements/doc.txt
- Use virtualenv to prevent flakiness in
make upgradetest
- Don't fill in a sample url pattern for Django apps, just suggest one in a comment
- Configure devstack Django settings to have a good JWT_AUTH and a DATABASES that point at the mysql container.
- Install mysqlclient
- The app container should accept stdin.
- Use the python dev server as the app container's command, since it can hot-reload.
- Rename containers in a more standard way.
- Clean pycrypto crap before requirements are built.
- Add devstack-themed make targets.
- Ignore emacs backup files.
- Ignores /healthcheck endpoint in monitoring for IDAs
- Tweaks to the READMEs to separate using cookiecutters from updating cookiecutters; clarify the use of a virtualenv for running cookiecutters; correct the way we talk about Slack and getting help; minor formatting improvements.
- Doc8 configs no longer have a max line length, which goes against our best practice to not use hard line breaks, as documented in OEP-19: Developer Documentation Best Practices.
- Include
JWT_AUTH_COOKIEin the baseJWT_AUTHsettings dict.
- Changed how oauth2_urlpatterns is imported in the urls.py file
- Added csrf.urls to IDA cookiecutter so that CSRF works
(some intervening changes not captured)
- Adding decision to make this repo the place for all edx cookiecutters.
- Used the layered approach for cookiecutter-xblock
- setup.py is now only in python-template
- Added cookiecutter-argocd-application
- a cookiecutter used by devops
- Added cookiecutter-xblock
- Added CHANGELOG