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

Use same workflow for build_docs and build-and-deploy #284

Closed
lucyleeow opened this issue Dec 3, 2023 · 3 comments · Fixed by #348
Closed

Use same workflow for build_docs and build-and-deploy #284

lucyleeow opened this issue Dec 3, 2023 · 3 comments · Fixed by #348
Labels
task

Comments

@lucyleeow
Copy link
Collaborator

🧰 Task

Could we use the same workflow to build docs in build_docs and build-and-deploy and only do the deploy step on:

    tags:
      - 'v*'

see: #283 (comment)

This means we do not have to remember to keep the 2 workflows consistent.

I am not an expert on github workflows, would this be possible @melissawm ?
@lucyleeow lucyleeow added the task label Dec 3, 2023
@lucyleeow lucyleeow mentioned this issue Dec 4, 2023
Merged
@melissawm
Copy link
Member

+1 from me, I am happy to put in a PR for that if there is consensus 😄

psobolewskiPhD pushed a commit that referenced this issue Dec 4, 2023
@lucyleeow
Add env constraint to 'deploy_docs' workflow (#287)
53a292f 
# References and relevant issues
Possible f i x es #283

# Description
Add constraints as env variable to the build step of 'deploy_docs'
workflow, matching the 'build_docs' workflow.

(no further improvement of these workflows attempted in this PR, they
can be done later, see #284)
@psobolewskiPhD psobolewskiPhD mentioned this issue Dec 4, 2023
Merged
@lucyleeow
Copy link
Collaborator Author

I think @psobolewskiPhD and @Czaki are both +1 on this too 😬

@lucyleeow
Copy link
Collaborator Author

I think this would reduce maintenance burden!

melissawm pushed a commit that referenced this issue Dec 5, 2023
@psobolewskiPhD
fix napari repo path to constraints (#290)
0c7029e 
# References and relevant issues
Fix failing deployment:
https://github.com/napari/docs/actions/runs/7093394130/job/19306680514
caused by #287

# Description
In the deploy workflow, napari is cloned into napari-repo:
`path: napari-repo  # place in a named directory`
fixing that here so that the constraints path in the ENV variable is
also using napari-repo and not napari.
Obviously overlooked this difference when reviewing
#287
Yet another reason to use just one workflow,
#284
@psobolewskiPhD psobolewskiPhD mentioned this issue Feb 28, 2024
Merged
psobolewskiPhD added a commit that referenced this issue Mar 27, 2024
@Czaki @psobolewskiPhD
Unify docs workflows (#348)
a77d2eb 
# Description
Closes: #284

This PR:

Unify build workflows from two to one. 

Remove .doctree directory (save 400MB)

---------

Co-authored-by: Peter Sobolewski <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
task
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Unify docs workflows Czaki/napari-docs
2 participants
@melissawm @lucyleeow