diff --git a/.github/workflows/upgrade-python-requirements.yml b/.github/workflows/upgrade-python-requirements.yml new file mode 100644 index 0000000..488ba78 --- /dev/null +++ b/.github/workflows/upgrade-python-requirements.yml @@ -0,0 +1,35 @@ +name: Upgrade Python Requirements + +on: + schedule: + # Run on the first day of the month. + # This is less frequent than the Open edX default (weekly), as this repo + # is old and barely used, and we just need to keep it working for another + # few releases. + - cron: "0 0 1 1 *" # First day of the month + workflow_dispatch: + inputs: + branch: + description: "Target branch against which to create requirements PR" + required: true + # If copying this template manually, you must provide your default branch name + # in quotes, such as 'master' + default: "master" + +jobs: + call-upgrade-python-requirements-workflow: + uses: openedx/.github/.github/workflows/upgrade-python-requirements.yml@master + with: + # If copying manually, also provide your default branch name in quotes here + branch: ${{ github.event.inputs.branch || "master" }} + # optional parameters below; fill in if you'd like github or email notifications + # user_reviewers: "" + # team_reviewers: "" + # email_address: "" + # send_success_notification: false + # python_version: "" + secrets: + requirements_bot_github_token: ${{ secrets.REQUIREMENTS_BOT_GITHUB_TOKEN }} + requirements_bot_github_email: ${{ secrets.REQUIREMENTS_BOT_GITHUB_EMAIL }} + edx_smtp_username: ${{ secrets.EDX_SMTP_USERNAME }} + edx_smtp_password: ${{ secrets.EDX_SMTP_PASSWORD }} diff --git a/README.rst b/README.rst index 337b096..51715cf 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,32 @@ -django-require -############## +openedx-django-require +###################### + +|pypi-badge| |ci-badge| |codecov-badge| + +.. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-django-require.svg + :target: https://pypi.python.org/project/openedx-django-require/ + :alt: PyPI + +.. |ci-badge| image:: https://github.com/openedx/django-require/workflows/Python%20CI/badge.svg?branch=main + :target: https://github.com/openedx/django-require/actions + :alt: CI + +.. |codecov-badge| image:: https://codecov.io/github/openedx/django-require/coverage.svg?branch=main + :target: https://codecov.io/github/openedx/django-require?branch=main + :alt: Codecov + **django-require** is a Django staticfiles post-processor for optimizing with `RequireJS `_. +*In the context of the Open edX project*, this django-require fork is used exclusively by +legacy frontend code in `edx-platform `_. +That frontend code is all either replaced or in the process of being replaced. +Once this process is complete, edx-platform will no longer need to +install django-require, and this fork will be archived. As such, please +consider this repository effectively deprecated and **do not use it in any +new code**. + License ******* @@ -18,13 +41,45 @@ is tagged `final-bsd-3c-contribution`_, are licensed by the original contributors under the terms of the `BSD 3-Clause License`_. The software is now maintained for the purpose of the Open edX -project by The Center for Reimagining Learning, which licenses +project by Axim Collaborative, Inc., which licenses any further contributions to this repository under the `Apache License 2.0`_. .. _final-bsd-3c-contribution: https://github.com/openedx/django-require/releases/tag/final-bsd-3c-contribution .. _Apache License 2.0: ./LICENSE .. _BSD 3-Clause License: ./LICENSE-BSD-3c +Contributing +************ + +Bugfixes and routine maintenance contributions are very welcome. +Please read `How To Contribute `_ for details. +Thank you! + +This repository is not accepting any new features nor refactors. + +The Open edX Code of Conduct +**************************** + +All community members are expected to follow the `Open edX Code of Conduct`_. + +.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/ + +People +****** + +The assigned maintainers for this component and other project details may be +found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml`` +file in this repo. + +.. _Backstage: https://backstage.openedx.org/catalog/default/component/django-require + +Reporting Security Issues +************************* + +Please do not report security issues in public. Please email security@openedx.org. + +django-require (Original Documentation) +####################################### Features ******** diff --git a/catalog-info.yaml b/catalog-info.yaml new file mode 100644 index 0000000..2618107 --- /dev/null +++ b/catalog-info.yaml @@ -0,0 +1,13 @@ +# This file records information about this repo. Its use is described in OEP-55: +# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html + +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + # (Required) Must be the name of the repo, without the owning organization. + name: 'django-require' +spec: + owner: user:kdmccormick + type: 'library' + lifecycle: 'deprecated' + subcomponentOf: 'edx-platform'