chore: simplify the api docs workflow#3186
Open
dougch wants to merge 3 commits into
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3186 +/- ##
==========================================
+ Coverage 78.17% 78.34% +0.17%
==========================================
Files 689 689
Lines 123732 123735 +3
Branches 17199 17204 +5
==========================================
+ Hits 96723 96941 +218
+ Misses 26089 25872 -217
- Partials 920 922 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
justsmth
reviewed
Jun 9, 2026
justsmth
approved these changes
Jun 11, 2026
justsmth
left a comment
justsmth
left a comment
Contributor
There was a problem hiding this comment.
Nit: Add pages-output/ to .gitignore?
WillChilds-Klein
left a comment
WillChilds-Klein
left a comment
Contributor
There was a problem hiding this comment.
This workflow only triggers on push to main, not on PRs — cannot be validated in CI before merge
what if a malformed comment in a PR causes this to fail? do we have some alarm to know main is broken? can this be caught before merge with a per-PR CI job?
| } | ||
| } | ||
|
|
||
| if err := os.MkdirAll(*outputDir, 0777); err != nil { |
Contributor
There was a problem hiding this comment.
do we need to give perms beyond user?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issues:
Resolves: none
Description of changes:
The
doc.gotool requires being run from theutil/directory with explicit--configand--outflags. This makes the GitHub Pages workflow brittle and the tool unusable from the repo root.as a reminder, the final doc URL: https://aws.github.io/aws-lc/api/headers.html
Changes:
doc.goauto-locates its config file viaruntime.Caller(0)— no more CWD dependencyOutputDirectoryfield todoc.configso output path lives in config, not the CLIBaseDirectoryandOutputDirectoryrelative to config file locationdoc.csscopy path to be config-relativeCall-outs:
workflow_dispatchcan be used to test manually after merge--configand--outflags still work as overridesTesting:
Run locally:
go run util/doc.gofrom repo root — generates docs inpages-output/, with the main entrypointpages-output/headers.html.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and the ISC license.