Skip to content

Update doc-build.yml #3045

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

Closed
svekars wants to merge 6 commits into from
Closed

Update doc-build.yml #3045

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6ceeac4
Update doc-build.yml
svekars Apr 15, 2024
775d9f0
Update doc-build.yml
svekars Apr 15, 2024
b78d28b
Update doc-build.yml
svekars Apr 15, 2024
446a5a7
Address comments
svekars Apr 16, 2024
edcd8ef
Minor fix
svekars Apr 16, 2024
06a77ce
Add a comment
svekars Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address comments
  • Loading branch information
@svekars
svekars committed Apr 16, 2024
commit 446a5a720775858464ec3018f122d6867379d187
2 changes: 2 additions & 0 deletions .github/workflows/doc-build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ jobs:
if [[ "${REF_TYPE}" == branch ]]; then
TARGET_FOLDER="${REF_NAME}"
elif [[ "${REF_TYPE}" == tag ]]; then
# Strip the leading "v" as well as the trailing patch version and "-rc" suffix.
# For example: 'v0.1.2' -> '0.1' and 'v0.1.2-rc1' -> 0.1.
case "${REF_NAME}" in
*-rc*)
echo "Aborting upload since this is an RC tag: ${REF_NAME}"
Copy link
Copy Markdown
Contributor

@dbort dbort Apr 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a comment explaining why it makes sense to abort when encountering an RC tag. Is it because we only want to generate docs for the actual release tag?

Copy link
Copy Markdown
Contributor Author

@svekars svekars Apr 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I believe this is what we do across other repositories - no documentation will be generated for v1.0.0-rc1 or similar.

Expand Down