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

Automatically run Django's collectstatic command #5

Closed
edmorley opened this issue Feb 28, 2023 · 0 comments · Fixed by #108
Closed

Automatically run Django's collectstatic command #5

edmorley opened this issue Feb 28, 2023 · 0 comments · Fixed by #108
Assignees
@edmorley
Labels
classic buildpack parity Features required for parity with the classic Heroku Python buildpack

Comments

@edmorley
Copy link
Member

edmorley commented Feb 28, 2023 •
edited
Loading

The classic Heroku Python buildpack automatically runs the Django collectstatic command:
https://github.com/heroku/heroku-buildpack-python/blob/main/bin/steps/collectstatic

Something similar to that should be added to the Python CNB for parity with the classic buildpack.

We should also bear in mind:

Django docs:

Internal tracking epic
@edmorley edmorley added enhancement New feature or request classic buildpack parity Features required for parity with the classic Heroku Python buildpack and removed enhancement New feature or request labels Feb 28, 2023
@edmorley edmorley mentioned this issue Sep 12, 2023
Merged
@edmorley edmorley self-assigned this Sep 12, 2023
edmorley added a commit that referenced this issue Sep 13, 2023
@edmorley
Automatically run Django's collectstatic command (#108)
64d5c7c 
The classic Heroku Python buildpack automatically runs the Django
`collectstatic` command:
https://github.com/heroku/heroku-buildpack-python/blob/main/bin/steps/collectstatic

This adds equivalent support, with a couple of improvements:
- This implementation performs more checks to see whether the app is
  actually using the static files feature before trying to run it
  (reducing the number of cases where users would need to manually
  disable it).
- The collectstatic symlink feature has been enabled, as requested in
  heroku/heroku-buildpack-python#1060.
- Symlinked `manage.py` files are now supported, as requested in
  heroku/heroku-buildpack-python#972.
- The error messages are finer grained/more useful.
- There are many more tests (including now testing legacy vs latest
  Django versions, to check the CLI arguments used work for both ends of
  the spectrum).

There is currently no way to force disable the feature (beyond removing
`django.contrib.staticfiles` from `INSTALLED_APPS` in the app's Django
config, or removing the `manage.py` script). Supporting this depends on
us deciding how best to handle buildpack options, so will be added
later, in #109.

The build log output and error messages are fairly reasonable already
(and a significant improvement over the classic buildpack), and will be
further polished as part of the future build output overhaul.

The implementation uses the new `utils::run_command_and_capture_output`
added in #106.

See:
* https://docs.djangoproject.com/en/4.2/howto/static-files/
* https://docs.djangoproject.com/en/4.2/ref/contrib/staticfiles/
* https://docs.djangoproject.com/en/4.2/ref/settings/#settings-staticfiles

Fixes #5.
GUS-W-9538294.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@edmorley edmorley

Labels
classic buildpack parity Features required for parity with the classic Heroku Python buildpack
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Automatically run Django's collectstatic command heroku/buildpacks-python
1 participant
@edmorley