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

Docs: add release GitHub action #1799

Closed
r3stl355 opened this issue Nov 3, 2023 · 0 comments · Fixed by #1801
Closed

Docs: add release GitHub action #1799

r3stl355 opened this issue Nov 3, 2023 · 0 comments · Fixed by #1801
Labels
enhancement New feature or request

Comments

@r3stl355
Copy link
Contributor

r3stl355 commented Nov 3, 2023

Description

Before I proceed with PR for creating the release action for docs I wanted to collect some feedback. Here are the options I see

  1. Modify the current deployment logic in .github/workflows/python_build.yml to deploy new docs instead of existing. Some sub-options here are

a. build into the root of the docs which mean they will accessible using https://delta-io.github.io/delta-rs/ (current sphinx docs are build into /python)
b. keep current sphinx for now (which means they will still be accessing via https://delta-io.github.io/delta-rs/pyton/)
c. do not build sphinx docs any more

  1. Instead modifying the current deployment script (which are using specific commands to checkout, clean, tag etc) use https://github.com/JamesIves/github-pages-deploy-action

  2. Put the release scripts into the .github/workflows/docs.yml to conditionally release if the script is run as part of release process. Trigger it using https://github.com/peter-evans/repository-dispatch from .github/workflows/python_release.yml

Thoughts?

Option 1 will be easiest, 1.b. will provide some safety in case new docs don't work. I'll proceed with this if there are no other suggestions
Option 2 may simplify the release logic but I am not sure it will all to do all we can with be-spoke commands like now
Option 3 is cleaner and keeps the the docs related actions together

@r3stl355 r3stl355 added the enhancement New feature or request label Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant