Use reusable-docs.yml in documentation-links#145346
Use reusable-docs.yml in documentation-links#145346KowalskiThomas wants to merge 3 commits intopython:mainfrom
reusable-docs.yml in documentation-links#145346Conversation
This comment was marked as resolved.
This comment was marked as resolved.
| paths: | ||
| - 'Doc/**' | ||
| - '.github/workflows/doc.yml' | ||
| - '.github/workflows/reusable-docs.yml' |
There was a problem hiding this comment.
This looks wrong. I imagine this was meant to be
| - '.github/workflows/reusable-docs.yml' | |
| - '.github/workflows/documentation-links.yml' |
It'd be useful to do some Git archaelogy to learn the original motivation, perhaps.
There was a problem hiding this comment.
OTOH, maybe it's okay to have both:
| - '.github/workflows/reusable-docs.yml' | |
| - '.github/workflows/reusable-docs.yml' | |
| - '.github/workflows/documentation-links.yml' |
Or use the change detection script that the main integrated workflow relies on (this might be an overkill).
There was a problem hiding this comment.
Thanks! I'll look into it and get back to you :)
There was a problem hiding this comment.
For context, the pattern of listing paths used to list the workflow itself so that it'd run if the automation itself changed in a PR.
There was a problem hiding this comment.
This looks wrong. I imagine this was meant to be ...
Do you mean the original version or my change? I made the change I made because that's what doc.yml was renamed to, but indeed it seems more usual/useful to make the workflow definition depend on changes on itself... I added it.
There was a problem hiding this comment.
I'll also do the archeology you mentioned, just in case there's something we're missing here :)
There was a problem hiding this comment.
Seems like this file was added in #103843 (back then, doc.yml did exist). My bet would be that doc.yml was copy-pasted to documentation_links.yml and this bit was not updated. In the meantime, doc.yml was renamed to reusable-docs.yml, which is what made me think that was the right new thing to run when changed.
Anyway, I think your suggestion is correct -- I'll update to use documentation-links.yml instead.
There was a problem hiding this comment.
@KowalskiThomas FYI accepting the suggestions like above via the GH UI is the way to go most of the time. This also reduced the chances of you introducing typos when trying to reproduce the same manually...
There was a problem hiding this comment.
Thank you, noted 👍
I'll keep that in mind!
|
This reminds me, https://github.com/readthedocs/actions is deprecated and we're planning to switch to using the Read the Docs app, see python/core-workflow#587. |
KowalskiThomas
requested review from
AA-Turner,
ezio-melotti and
hugovk
as code owners
|
@hugovk thanks for your comment, based on what I see on the PR you linked the work is still a few repos away from being usable in CPython, right? Happy to take a stab at it if that's what you were suggesting, but my understanding is that it's not time yet. |
|
Yeah, initially the idea was to wait a bit, but I now think we should do CPython first: python/core-workflow#587 (comment). So instead we'll need to do some config via the RTD web UI and then remove this file. |
Do you expect this to be happening soon? Just to know if I close this PR or if I leave it open! |
|
Yeah hopefully, when @JacobCoffee has time for it, although he's the only one in the infra team right now. Relatedly, if you know someone in the US who's looking for a job, the PSF is recruiting! Spread the word! https://jobs.pyfound.org/apply/DNzZlBUqFn/Infrastructure-Engineer |
| paths: | ||
| - 'Doc/**' | ||
| - '.github/workflows/doc.yml' | ||
| - '.github/workflows/documentation-links.sh' |
There was a problem hiding this comment.
huh? .sh?
| - '.github/workflows/documentation-links.sh' | |
| - '.github/workflows/documentation-links.yml' |
4 participants
What is this?
Currently, the
documentation-linksrefers todoc.ymlwhich doesn't exist.I suspect the correct file to reference isAfter some Git archeology, this turned out to be incorrect.reusable-docs.yml, based on just looking at commit history fordoc.ymland seeing 88d14da.Seems like
documentation-links.ymlwas added in #103843 (back then,doc.ymldid exist). My bet would be thatdoc.ymlwas copy-pasted todocumentation_links.ymland this bit was not updated. In the meantime,doc.ymlwas renamed toreusable-docs.yml, which is what made me think that was the right new thing to run when changed.Note I didn't add neither a GitHub Issue number nor a News entry as I don't think this warrants either, but feel free to tell me if I should.