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

Add documentation generation badges #2110

Merged
merged 7 commits into from Nov 2, 2022
Merged

Add documentation generation badges #2110

merged 7 commits into from Nov 2, 2022

Conversation

daveverwer
Copy link
Member

Fixes #1887

The intention here is that the build should show the badge if it even attempted a documentation build so we can find the correct build to start debugging.

I'm not super happy with this wording:

If successful, this build generated package documentation.

I did consider:

This build attempted to build documentation.

Here's how it looks:

Screenshot 2022-11-01 at 16 20 27@2x

Screenshot 2022-11-01 at 16 20 41@2x

@daveverwer daveverwer marked this pull request as draft November 1, 2022 18:03
@daveverwer daveverwer marked this pull request as ready for review November 1, 2022 18:53
@daveverwer daveverwer marked this pull request as draft November 1, 2022 18:54
@finestructure
Copy link
Member

I must be missing something – I can't figure out where the logic sits that determines which build is supposed to build the docs.

I was expecting to see somewhere something looking at the SPIManifest or to have it reported back from the build system (probably better) what build generated the docs.

@finestructure
Copy link
Member

Oh, I see. This is the display and #1888 is the data 👍

@daveverwer daveverwer marked this pull request as ready for review November 2, 2022 08:38
@daveverwer daveverwer merged commit 2a48ec1 into main Nov 2, 2022
@daveverwer daveverwer deleted the fix-1887 branch November 2, 2022 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Indicate which builds include documentation generation
2 participants