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.

Sign up for GitHub

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

Jump to bottom

Move docs dependencies to common location and check for broken docs on pull request #6919

Merged
merged 6 commits into from
Oct 23, 2024
Merged

Move docs dependencies to common location and check for broken docs on pull request #6919

merged 6 commits into from
Oct 23, 2024

Conversation

smokestacklightnin
Copy link
Contributor

This PR accomplishes two main things

  • Move the docs dependencies to docs-requirements.txt. Before, the requirements were repeated in tfx/dependencies.py and in the github docs workflow.
  • Build but do not deploy the docs on pull request. This is to check if any PR will break the docs.

@smokestacklightnin
Move dependencies for docs to requirements-docs.txt so they don't n…
1f36d90 
…eed to be duplicated in the github docs workflow
@smokestacklightnin smokestacklightnin force-pushed the ci/docs/check-docs-on-pull-request branch from 2d18f58 to 1f36d90 Compare September 29, 2024 07:28
peytondmurray
peytondmurray requested changes Sep 29, 2024
View reviewed changes
.github/workflows/cd-docs.yml Outdated Show resolved Hide resolved
tfx/dependencies.py Show resolved Hide resolved
@keerthanakadiri keerthanakadiri self-assigned this Sep 30, 2024
peytondmurray
peytondmurray approved these changes Oct 1, 2024
View reviewed changes
Copy link
Contributor

@peytondmurray peytondmurray left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Looks good, except for the comment about verbose mode. I'll approve now, please remove the verbose flag unless it's actually needed here.

@peytondmurray peytondmurray self-requested a review October 1, 2024 18:06
peytondmurray
peytondmurray approved these changes Oct 1, 2024
View reviewed changes
.github/workflows/cd-docs.yml Outdated Show resolved Hide resolved
peytondmurray
peytondmurray requested changes Oct 2, 2024
View reviewed changes
Copy link
Contributor

@peytondmurray peytondmurray left a comment

Choose a reason for hiding this comment

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

I think this deploys the docs on every push to any branch. We should only publish when there's a push to master.

.github/workflows/cd-docs.yml Show resolved Hide resolved
peytondmurray
peytondmurray approved these changes Oct 4, 2024
View reviewed changes
Copy link
Contributor

@peytondmurray peytondmurray left a comment

Choose a reason for hiding this comment

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

Looks great. Thank you!

lego0901
lego0901 approved these changes Oct 23, 2024
View reviewed changes
Copy link
Member

@lego0901 lego0901 left a comment

Choose a reason for hiding this comment

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

Thanks!

@peytondmurray peytondmurray merged commit 6ac79b8 into tensorflow:master Oct 23, 2024
15 checks passed
@peytondmurray peytondmurray deleted the ci/docs/check-docs-on-pull-request branch October 23, 2024 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lego0901 lego0901 lego0901 approved these changes

@peytondmurray peytondmurray peytondmurray approved these changes

@roseayeon roseayeon Awaiting requested review from roseayeon

Assignees

@keerthanakadiri keerthanakadiri

Labels
type:docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@smokestacklightnin @peytondmurray @lego0901 @keerthanakadiri