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

Add doc_builder_revision as workflow input to ease debugging #399

Merged
merged 1 commit into from
Sep 21, 2023

Conversation

Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Sep 20, 2023

Doesn't change much for existing repo (will still use the main branch) but useful if we want to quickly try a 'doc-builder' PR on another library repo. Should avoid to push a temporary commit like this next time: #398 (comment)

cc @mishig25 @xenova

@Wauplin Wauplin requested review from mishig25 and xenova September 20, 2023 15:14
@Wauplin
Copy link
Contributor Author

Wauplin commented Sep 20, 2023

CI will fail because of #398 (comment) but not related to this PR.

Copy link
Contributor

@mishig25 mishig25 left a comment

Choose a reason for hiding this comment

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

lgtm! Amazing

Could you add a small section on readme telling that: when you are testing a new doc build, you need to do

  1. Set the uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@{YOUR BRANCH}
  2. And provide this argument doc_builder_revision

@mishig25 mishig25 merged commit 0fa2373 into main Sep 21, 2023
2 of 4 checks passed
@mishig25 mishig25 deleted the extra-debug-arg-in-workflow branch September 21, 2023 08:56
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.

2 participants