Better handling of .gitkeep in demo-files #2304
Merged
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
added 3 commits
September 25, 2024 13:44
Files called ".gitkeep" are used as placeholders to tell git to create the directory. They shouldn't be copied as part of the demo project content (in fact, a file called ".gitkeep" would not be allowed by the file upload form.) For example, the demo active project AGlSZa5VTv5Dg09CSpoh contains no actual files, but the git repository includes the file demo-files/media/active-projects/AGlSZa5VTv5Dg09CSpoh/.gitkeep - so in this case, loaddemo should create an empty project directory media/active-projects/AGlSZa5VTv5Dg09CSpoh .
If a directory such as 'media/active-projects/AGlSZa5VTv5Dg09CSpoh' already exists, and we are trying to install a demo project there, don't raise an error. That directory isn't present in the git repository, but it might have been created in the past.
Files called ".gitkeep" are used as placeholders to tell git to create the directory. They shouldn't be copied as part of the demo project content (in fact, a file called ".gitkeep" would not be allowed by the file upload form.) For example, the demo active project AGlSZa5VTv5Dg09CSpoh contains no actual files, but the git repository includes the file demo-files/media/active-projects/AGlSZa5VTv5Dg09CSpoh/.gitkeep - so in this case, TestMixin should create an empty project directory.
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.
We use
.gitkeepfiles as placeholders for "empty" directories. For example we have two demo active projects that don't contain any files, and we want theloaddemocommand to create project directories for them. However,loaddemo(orTestMixin, which loads the demo files for the test suite) shouldn't create an actual.gitkeepfile in the project directory.Additionally,
loaddemoshouldn't fail if the demo project directory already exists.Should fix problems with
test-upgrade.shas seen in #2303.