-
Notifications
You must be signed in to change notification settings - Fork 190
Conversation
Codecov Report
✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.34%. Comparing base (7f7d548) to head (f78a332).
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.
📢 Have feedback on the report? Share it here.
🚀 New features to boost your workflow:
- ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@justsmth
justsmth
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Add pages-output/ to .gitignore?
@WillChilds-Klein
WillChilds-Klein
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need to give perms beyond user?
Uh oh!
There was an error while loading. Please reload this page.
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.