Skip to content

Add documentation generation to GitHub's build-and-test#2190

Merged
artwyman merged 2 commits into
mainfrom
artwyman/docs-test
May 26, 2025
Merged

Add documentation generation to GitHub's build-and-test#2190
artwyman merged 2 commits into
mainfrom
artwyman/docs-test

Conversation

@artwyman
Copy link
Copy Markdown
Member

@artwyman artwyman commented Dec 21, 2024

Expected to fail on the current state of main. Fix incoming in #2189, but I want to confirm this test would catch the issue.

@artwyman artwyman requested a review from robknight December 21, 2024 02:17
@artwyman artwyman self-assigned this Dec 21, 2024
@artwyman artwyman added the test label Dec 21, 2024
@artwyman artwyman mentioned this pull request Dec 21, 2024
Merged
@artwyman
Copy link
Copy Markdown
Member Author

artwyman commented Dec 21, 2024

Test failed in the expected way. Going to rebase on top of #2189 to ensure it passes.

@artwyman artwyman changed the base branch from main to artwyman/fix-docs December 21, 2024 07:32
@artwyman
Copy link
Copy Markdown
Member Author

artwyman commented Dec 21, 2024

I'm confused by the repeat failure. Seems like it's showing the same issue fixed in the parent PR, which I don't see when I test locally. Going to try tweaking a few things.

@artwyman
Copy link
Copy Markdown
Member Author

artwyman commented Dec 21, 2024

Ah, I now suspect some interaction of force-push with the attempt by GitHub to block me pushing workflow changes with a client not authorized for them. Let's see what I can do with the GitHub client.

@artwyman artwyman marked this pull request as ready for review December 21, 2024 08:27
github-merge-queue Bot pushed a commit that referenced this pull request Dec 21, 2024
@artwyman
Fix Typedoc (#2189)
f607c44 
The config file changes related to include paths are what fixed the
actual error. See #2190 for a proposed workflow change to detect this
kind of breakage on PRs.

I also addressed many (but not all) of the doc-generation warnings and
broken links.
Base automatically changed from artwyman/fix-docs to main December 21, 2024 23:03
@artwyman
Copy link
Copy Markdown
Member Author

artwyman commented Dec 21, 2024

Rebased after the parent PR merged. This is ready to review and merge @robknight

@artwyman artwyman force-pushed the artwyman/docs-test branch from cccf4fb to 1f04710 Compare May 22, 2025 00:39
@artwyman
Copy link
Copy Markdown
Member Author

artwyman commented May 22, 2025

This got forgotten but I'd like to resurrect it now. While not a priority, the intent of making sure our generated docs don't break when code changes seems a good one.

I just rebased and force-pushed to confirm that this still passes on the latest state of main.

@artwyman
Copy link
Copy Markdown
Member Author

artwyman commented May 22, 2025

When I run yarn docs locally it suceeds, with some warnings about broken links, which is the same state I remember from the last time I fixed docs.

@artwyman artwyman added this pull request to the merge queue May 26, 2025
Merged via the queue into main with commit 2353204 May 26, 2025
1 of 2 checks passed
@artwyman artwyman deleted the artwyman/docs-test branch May 26, 2025 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@robknight robknight robknight approved these changes

Assignees

@artwyman artwyman

Labels

test

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@artwyman @robknight