Skip to content

Use reusable-docs.yml in documentation-links#145346

Draft
KowalskiThomas wants to merge 2 commits intopython:mainfrom
KowalskiThomas:kowalski/use-reusable-docs-yml-in-documentation-links
Draft

Use reusable-docs.yml in documentation-links#145346
KowalskiThomas wants to merge 2 commits intopython:mainfrom
KowalskiThomas:kowalski/use-reusable-docs-yml-in-documentation-links

Conversation

@KowalskiThomas
Copy link
Contributor

@KowalskiThomas KowalskiThomas commented Feb 28, 2026

What is this?

Currently, the documentation-links refers to doc.yml which doesn't exist. I suspect the correct file to reference is reusable-docs.yml, based on just looking at commit history for doc.yml and seeing 88d14da.

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.

@bedevere-app

This comment was marked as resolved.

paths:
- 'Doc/**'
- '.github/workflows/doc.yml'
- '.github/workflows/reusable-docs.yml'
Copy link
Member

Choose a reason for hiding this comment

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

This looks wrong. I imagine this was meant to be

Suggested change
- '.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.

Copy link
Member

Choose a reason for hiding this comment

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

OTOH, maybe it's okay to have both:

Suggested change
- '.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).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! I'll look into it and get back to you :)

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll also do the archeology you mentioned, just in case there's something we're missing here :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants