Skip to content

[CI] docs: Configure docs publish for releases #5047

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

Merged
merged 2 commits into from
Jun 19, 2024

Conversation

frascuchon
Copy link
Member

This PR reviews the workflow for publishing docs:

  • A merge to the main (release/stable branch) will deploy docs latest version.
  • A tag creation (tag pattern = v*) will deploy vX.Y.Z version. (we can iterate on this and keep just the minor version)

Copy link
Contributor

@davidberenstein1957 davidberenstein1957 left a comment

Choose a reason for hiding this comment

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

Some small changes.

  • let's not deplot docs/ now
  • deploy a develop version with latest changes but not set this as default
  • deploy new versions on release tags and set it to the latest tag by default.

@frascuchon
Copy link
Member Author

Some small changes.

  • let's not deplot docs/ now

:+1 I've removed conditions for that!

  • deploy a develop version with latest changes but not set this as default

Normally the latest docs refer to the latest release. We already have the dev version for this.

  • deploy new versions on release tags and set it to the latest tag by default.

We can have version problems publishing patch releases. The latest changes for docs will be on the last commit on main.

@frascuchon frascuchon merged commit 5ef4a8c into releases/2.0.0-alpha0 Jun 19, 2024
1 check passed
@frascuchon frascuchon deleted the ci/prepare-docs-release branch June 19, 2024 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants