[redwood backport] allow symlinks to be used in place of static asset artifacts #34970
+5
−7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The git-ignored target directory for LMS Sass compilation is:
lms/static/css
Unfortunately, that directory contains git-controlled directory of
vendored-in static assets:
lms/static/css/vendor
This is a problem for a couple reasons:
1. In Tutor, we would like to make lms/static/css a symlink to an
external location for the sake of build efficiency. This is
impossible to do without clobbering lms/static/css/vendor and
dirtying the git state.
2. More generally, when optimizing (or just understanding) a build
system, it adds complexity when git-controlled source directories are
mixed up inside git-ignored target directories.
The solution is to simply merge these vendored-in assets to another
existing git-controlled vendor directory:
common/static/css/vendor
LMS already reads assets from this folder, so no further changes need to
be made. common/static/css is fully git-controlled, so we avoid the
complexity described above.
Backport of: 97a9f08
Remove the trailing slashes from the .gitignore entries for static asset build artifacts. With these slashes, only directory contents are ignored. Without these slashes, the artifact is ignored whether it is a directory *or* an actual file (particularly, in our case: a symlink). This allows us to build edx-platform static assets into a separate directory, and then symlink to them from edx-platform. Also: We remove the duplicate cms/static/css/ gitignore entry. Backport of: 1f41529
kdmccormick
added
the
create-sandbox
|
@feanil Since you reviewed the original PR, can you give this backport a preliminary thumbs-up too? I'll still get Max's final approval before merging. |
|
Sandbox deployment successful 🚀 |
cmltaWt0
approved these changes
Jun 17, 2024
kdmccormick
merged commit 6ab0b7a
into
openedx:open-release/redwood.master
78 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Backports #34894 to Redwood.
Testing
I will verify the LMS/Studio frontend functionality with this branch using the linked sandbox (UN: openedx, PW: openedx)
Merge considerations / rationale
This is low/no risk and fully backwards-compatible.
With this PR: This PR makes possible an experimental significant optimization to Tutor Dev setup time. That optimization will not be ready for Tutor v18.0.0 (the initial Redwood release), but it will hopefully be ready for Tutor v18.1.0. Backporting this PR to Redwood makes that possible.
Without this PR: the Tutor Dev optimization mentioned above could be made available on Tutor Nightly, but it would not be feasible for standard Tutor until Sumac (v19.0.0).