Skip to content

Conversation

seveibar
Copy link
Contributor

@seveibar seveibar commented Oct 4, 2025

Summary

  • add repository guidance in AGENTS.md with required generation workflow
  • create a GitHub Action that runs required generation scripts (excluding the KiCad autocomplete generator) and fails on dirty diffs
  • refresh generated documentation to reflect current PlatformConfig fields

Testing

  • bunx tsc --noEmit
  • bun run format

https://chatgpt.com/codex/tasks/task_b_68e168266048832eab3e6d5a4e2f13d1

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting

Comment on lines +23 to +34
- name: Run generation scripts
run: |
bun scripts/generate-component-types.ts
bun scripts/generate-manual-edits-docs.ts
bun scripts/generate-readme-docs.ts
bun scripts/generate-props-overview.ts

- name: Ensure working tree is clean
run: |
if ! git diff --quiet; then
echo "Generated files are out of date. Please run the generation scripts and commit the results." >&2
git status --short

Choose a reason for hiding this comment

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

P1 Badge Avoid non-deterministic diff in generated verification workflow

The verification job always runs scripts/generate-props-overview.ts, which rewrites generated/PROPS_OVERVIEW.md with > Generated at ${new Date().toISOString()} on each invocation. Even when the committed artifacts are up to date, this timestamp changes on CI and git diff --quiet will fail, blocking every PR. The workflow needs to ignore the timestamp, make the generator deterministic, or skip that file entirely so that a clean working tree is possible.

Useful? React with 👍 / 👎.

@seveibar seveibar merged commit 01d3419 into main Oct 4, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant