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

Update deploy_docs.yml to use metadata to use proper napari version substitution #99

Merged
merged 1 commit into from
Feb 13, 2023

Conversation

psobolewskiPhD
Copy link
Member

Description

See napari/napari#5509 (comment)
The docs live on napari.org don't match PR action downloaded docs when doing napari version substitution (#51)

Live, napari.org docs:

PR built docs, download zip:

This PR updates the deploy action with fetch-depth: 0 that was added to the PR build_docs action. This should make the version metadata be correct (see pypa/setuptools-scm#480)

Type of change

  • Fixes or improves existing content
  • Adds new content page(s)
  • Fixes or improves workflow, documentation build or deployment

References

Adresses issue noted here napari/napari#5509 (comment)

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have added alt text to new images included in this PR

I'm not sure how to test this or check that it's correct, because the issue is already fixed in PR builds.

Copy link
Member

@jni jni left a comment

Choose a reason for hiding this comment

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

Wow. Nice investigating and reference linking! 🙏

@psobolewskiPhD psobolewskiPhD merged commit 506e476 into napari:main Feb 13, 2023
@psobolewskiPhD psobolewskiPhD deleted the psobolewskiPhD-patch-3 branch February 13, 2023 13:58
psobolewskiPhD added a commit to napari/napari that referenced this pull request Feb 14, 2023
…stitutions (#5557)

# Description

This PR an an analog to napari/docs#99
The built docs built by this repo PR action have improper napari version
substitution (see napari/docs#51)

This PR fixes that based on the README of
https://github.com/actions/checkout
It updates the deploy action with `fetch-depth: 0`. You can see that
this was added to the napari/docs PR build_docs action and works
correctly. This makes the version metadata be correct (see
pypa/setuptools-scm#480)

## Type of change
- [x] Bug-fix (non-breaking change which fixes an issue)

# References
Motivated by napari/docs#51
Analog to napari/docs#99
@psobolewskiPhD psobolewskiPhD added this to the 0.4.18 milestone Jun 22, 2023
@Czaki Czaki modified the milestones: 0.4.18, 0.5.0 Jun 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants