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.

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

only update docs site on tags #178

Merged
merged 2 commits into from
Nov 4, 2024

Conversation

jameslamb
Copy link
Member

Contributes to #115

In https://github.com/rapidsai/ops/issues/3582 (private link, sorry) we've reached the conclusion that having 2 GitHub Pages deployments from the same commit doesn't work. This means that when a commit is tagged as a stable release, a new docs deployment switching to the stable version number (e.g. 24.08.02) doesn't work ("succeeds" in CI, but the docs are not updated).

To get around that for now, this proposes not deploying docs on pushes of new commits. As of this PR, the docs site will only be updated under the following conditions:

  • push a new tag
  • manually trigged the build workflow from the GitHub UI and choose deploy_docs = true from the drop-down menu

@jameslamb jameslamb added improvement Improves an existing functionality non-breaking Introduces a non-breaking change labels Nov 4, 2024
Copy link
Contributor

@seberg seberg left a comment

Choose a reason for hiding this comment

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

This seems perfectly good to me, nice touch with the drop-down (I didn't know you can do that).

@jameslamb jameslamb merged commit cf4ee59 into rapidsai:main Nov 4, 2024
9 checks passed
@jameslamb jameslamb deleted the no-docs-deploy-on-merges branch November 4, 2024 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improves an existing functionality non-breaking Introduces a non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants