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

Collect edx-platform assets without Paver #31658

Closed
1 task
kdmccormick opened this issue Jan 25, 2023 · 1 comment · Fixed by #31934
Closed
1 task

Collect edx-platform assets without Paver #31658

kdmccormick opened this issue Jan 25, 2023 · 1 comment · Fixed by #31934
Assignees
@kdmccormick

Comments

@kdmccormick
Copy link
Member

kdmccormick commented Jan 25, 2023 •
edited
Loading

Background

Part of:

See the "Collect" row in the Commands and Stages table in the ADR.

Subtasks

  • Move ignore patterns to an AppConfig object

Notes

None
@kdmccormick kdmccormick mentioned this issue Jan 25, 2023
Closed
8 tasks
@kdmccormick kdmccormick changed the title Reimplement asset collection in sh Reimplement asset collection in bash Feb 14, 2023
@kdmccormick kdmccormick changed the title Reimplement asset collection in bash Collect edx-platform assets without Paver Feb 21, 2023
@kdmccormick kdmccormick mentioned this issue Feb 21, 2023
Closed
@kdmccormick kdmccormick self-assigned this Feb 21, 2023
@kdmccormick kdmccormick moved this from 📥 New to 🛠️ In Progress in Developer Experience Working Group Feb 21, 2023
@kdmccormick kdmccormick moved this from 🛠️ In Progress to 📥 New in Developer Experience Working Group Feb 24, 2023
@kdmccormick kdmccormick mentioned this issue Mar 15, 2023
Closed
@kdmccormick kdmccormick mentioned this issue Mar 15, 2023
Merged
@kdmccormick
Copy link
Member Author

Implemented by: #31934

@kdmccormick kdmccormick moved this from 📥 New to 🛠️ In Progress in Developer Experience Working Group Mar 15, 2023
@kdmccormick kdmccormick moved this from 🛠️ In Progress to 👀 In Review in Developer Experience Working Group Apr 19, 2023
kdmccormick added a commit to kdmccormick/edx-platform that referenced this issue Apr 20, 2023
@kdmccormick
build: move collectstatic ignore patterns into configuration
d35df76 
Django provides the `collectstatic` management command, which collects static
assets into the STATIC_ROOT so that they can be served by some system external
to Django (like nginx or caddy), as is usually desired in production environments.

edx-platform contains several types of files that we don't want to be collected
into the STATIC_ROOT. Previously, these files had to be supplied to the manageme
nt command using the `--ignore` option:

    ./manage.py lms collectstatic --ignore geoip --ignore sass ...etc
    ./manage.py cms collectstatic --ignore geoip --ignore sass ...etc

This yields a long, hard-to-remember command. Paver wrapped the command in its
big `paver update_assets` task, but that task also builds assets, which is totally
overkill when you're just trying to collect them.

Fortunately, `collectstatic`'s default ignore patterns can be configured by
defining a custom AppConfig class. We define such an config
(`EdxPlatformStaticFilesConfig`) for LMS and CMS. Now, devs can collect LMS and
CMS assets with just:

    ./manage.py lms collectstatic
    ./manage.py cms collectstatic

Further reading on collecstatic and --ignore:
https://docs.djangoproject.com/en/3.2/ref/contrib/staticfiles/#customizing-the-i
gnored-pattern-list

Further reading on eschewing Paver:
https://github.com/openedx/edx-platform/blob/master/docs/decisions/0017-reimplem
ent-asset-processing.rst

Closes: openedx#31658
kdmccormick added a commit that referenced this issue Apr 21, 2023
@kdmccormick
build: move collectstatic ignore patterns into configuration (#31934)
151c4fc 
Adds a tiny `openedx.core.djangoapps.staticfiles` app so that
static asset ignore patterns can be coded into configuration rather
than supplied on the command line or coded into pavelib.
Makes it easier to run static asset collection without Paver.

See ADR for details:
openedx/core/djangoapps/staticfiles/docs/decisions/0001-purpose-of-app.rst

Closes: #31658
@github-project-automation github-project-automation bot moved this from 👀 In Review to 🚀 Closed in Developer Experience Working Group Apr 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kdmccormick kdmccormick

Labels
None yet
Projects
No open projects
Developer Experience Working Group
Status: Closed
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

build: move collectstatic ignore patterns into configuration kdmccormick/edx-platform
1 participant
@kdmccormick