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

Update documentation workflow to only publish one version per major #9731

Merged
merged 8 commits into from
Oct 6, 2021

Conversation

tczekajlo
Copy link
Contributor

Proposed changes:

Status (please check what you already did):

  • added some tests for the functionality
  • updated the documentation
  • updated the changelog (please check changelog for instructions)
  • reformat files using black (please check Readme for instructions)

@tczekajlo tczekajlo self-assigned this Sep 28, 2021
@tczekajlo tczekajlo requested a review from m-vdb September 28, 2021 11:12
@tczekajlo
Copy link
Contributor Author

@m-vdb Can you 👀 if you have a minute? I hope I got it right 😄

Copy link
Collaborator

@m-vdb m-vdb left a comment

Choose a reason for hiding this comment

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

Nice 🎉 thanks a lot @tczekajlo ! I think there is one part missing, about running the docs script itself here, which is creating a new version of the docs for new majors only, not minors. I think we just need to update the two patterns and we should be good to go (at first sight 🤔 )

.github/workflows/documentation.yml Outdated Show resolved Hide resolved
.github/workflows/documentation.yml Outdated Show resolved Hide resolved
@tczekajlo tczekajlo requested a review from m-vdb September 29, 2021 09:56
Signed-off-by: tczekajlo <[email protected]>
@tczekajlo tczekajlo requested a review from m-vdb September 30, 2021 14:53
scripts/push_docs_to_branch.sh Outdated Show resolved Hide resolved
@m-vdb
Copy link
Collaborator

m-vdb commented Oct 1, 2021

@tczekajlo before merging this PR, I will need to wrap-up this one (remaining step is to merge the 2.8 docs manually into 2.x). I'll put this up today and ask for a review from CSE. Another thing we'll need to do around the same time is disable the docs workflows on at least 2.7, 2.6 (mostly a safety measure, in case people push new tags there. I don't expect it, but....). I can take care of this and I'll ask a review from you if that's alright

@tczekajlo tczekajlo linked an issue Oct 4, 2021 that may be closed by this pull request
@tczekajlo tczekajlo requested a review from m-vdb October 4, 2021 14:58
@m-vdb
Copy link
Collaborator

m-vdb commented Oct 4, 2021

awesome 💯 @tczekajlo I will approve the PR and merge it once the documentation branch is ready 👍🏻

@m-vdb m-vdb merged commit 6d01906 into 2.8.x Oct 6, 2021
@m-vdb m-vdb deleted the update_docs_workflow branch October 6, 2021 14:22
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.

update documentation workflow to only publish one version per major
2 participants