-
Notifications
You must be signed in to change notification settings - Fork 1k
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
Add documentation publishing workflow to standalone repo #5081
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This will take me 1,000 attempts to get working. |
charliermarsh
force-pushed
the
charlie/docs-repo
branch
15 times, most recently
from
July 15, 2024 21:43
cf553c0
to
079654b
Compare
charliermarsh
added
documentation
Improvements or additions to documentation
internal
A refactor or improvement that is not user-facing
labels
Jul 15, 2024
charliermarsh
force-pushed
the
charlie/docs-repo
branch
from
July 15, 2024 21:45
079654b
to
7f037f7
Compare
charliermarsh
force-pushed
the
charlie/docs-base
branch
from
July 15, 2024 21:46
1b0e64d
to
bfc90c5
Compare
charliermarsh
force-pushed
the
charlie/docs-repo
branch
from
July 15, 2024 21:46
7f037f7
to
b535fe8
Compare
charliermarsh
force-pushed
the
charlie/docs-base
branch
3 times, most recently
from
July 15, 2024 22:14
e61ae8f
to
cebbeab
Compare
charliermarsh
force-pushed
the
charlie/docs-repo
branch
from
July 15, 2024 22:22
b535fe8
to
d5a4d00
Compare
zanieb
reviewed
Jul 15, 2024
zanieb
reviewed
Jul 15, 2024
zanieb
reviewed
Jul 15, 2024
zanieb
reviewed
Jul 15, 2024
charliermarsh
force-pushed
the
charlie/docs-repo
branch
2 times, most recently
from
July 15, 2024 23:57
0c15a46
to
ca17064
Compare
Thanks @zanieb! |
charliermarsh
force-pushed
the
charlie/docs-repo
branch
from
July 16, 2024 02:27
ca17064
to
c067ee1
Compare
zanieb
approved these changes
Jul 16, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome :)
charliermarsh
force-pushed
the
charlie/docs-repo
branch
from
July 16, 2024 13:04
c067ee1
to
77df654
Compare
dhruvmanila
pushed a commit
to astral-sh/ruff
that referenced
this pull request
Jul 18, 2024
## Summary See: astral-sh/uv#5081
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
internal
A refactor or improvement that is not user-facing
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This approach is based on https://github.com/PrefectHQ/docs. Rather than publishing docs in the uv repo, we push to an independent repo that's used solely to house the docs. In Prefect's case, this allows them to publish versioned documentation (we should do that too). For us, though, the benefit is that we can publish the Ruff and uv docs as a single site (docs.astral.sh).
Prefect clones the source repo and builds the documentation from the
docs
repo (i.e., the action runs in thedocs
repo). In our case, I've instead set it up such that the action runs inuv
(and later inruff
too), clones thedocs
repo, and puts up a PR in that separate repo. Because of these requirements, we have to use a PAT rather than a deploy key (as PATs cannot do GitHub-specific things like create PRs -- they can only operate over the Git CLI).See: astral-sh/docs#2.