-
Notifications
You must be signed in to change notification settings - Fork 141
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.
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
Update copy command in MkDocs build instruction to prevent copying to wrong location #1148
Open
bact
wants to merge
11
commits into
spdx:develop
Choose a base branch
from
bact:update-build-instructions
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
Adjust copy command to make it still copy individual subdirs inside mkdocs dir (but not the mkdocs dir itself), if spdx-spec/docs/model/ and spdx-spec/docs/rdf/ are already exists. Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
bact
added
doc improvement
Area where the project documentation needs improvement
ci
Dev workflow and repo management
labels
Nov 14, 2024
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
goneall
approved these changes
Nov 14, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
ci
Dev workflow and repo management
doc improvement
Area where the project documentation needs improvement
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.
Adjust copy command in the instruction to make it still copy individual subdirs inside
parser_output/mkdocs
dir (but not themkdocs
dir itself), even ifspdx-spec/docs/model/
andspdx-spec/docs/rdf
dirs are already exists.What is wrong?
If
spdx-spec/docs/model/
exists, the current command:will results this content inside the
spdx-spec/docs/model/
dir:which is not what we want. We want the subdirs to be copied at this level, as MkDocs expected.
What this PR do?
This PR update the command to:
mkdir -p spdx-spec/docs/model cp -R parser_output/mkdocs/* spdx-spec/docs/model
which will give this expected result in the
spdx-spec/docs/model/
dir, no matter if the dir exists before or not:This is new command also to prevent the case that the user may already have model subdirs inside
spdx-spec/docs/model/
dir from a previous run of spec generation and want to try another run. When they make copy with the current copy command, it will results to the below content (note themkdocs
subdir at the last row at the very end):This will lead to MkDocs errors.