-
Notifications
You must be signed in to change notification settings - Fork 269
feat: update architecture diagram workflow to maintain scratchpad/architecture.md #19212
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -7,6 +7,7 @@ on: | |||||
| permissions: | ||||||
| contents: read | ||||||
| issues: read | ||||||
| pull-requests: read | ||||||
|
|
||||||
| engine: copilot | ||||||
|
|
||||||
|
|
@@ -23,6 +24,10 @@ safe-outputs: | |||||
| close-older-issues: true | ||||||
| expires: 7 | ||||||
| max: 1 | ||||||
| create-pull-request: | ||||||
| expires: 7 | ||||||
| title-prefix: "[architecture] " | ||||||
| labels: [architecture, diagram, documentation] | ||||||
| noop: | ||||||
|
|
||||||
| imports: | ||||||
|
|
@@ -176,3 +181,30 @@ A compact table of all packages with their layer and one-line description: | |||||
| | cli | Core | Command implementations | | ||||||
| | workflow | Core | Workflow compilation engine | | ||||||
| | ... | ... | ... | | ||||||
|
|
||||||
| ## Scratchpad File | ||||||
|
|
||||||
| After creating the issue, update `scratchpad/architecture.md` with the latest diagram via `create_pull_request`. | ||||||
|
|
||||||
| The file should contain: | ||||||
|
|
||||||
| ````markdown | ||||||
| # Architecture Diagram | ||||||
|
|
||||||
| > Last updated: <YYYY-MM-DD> · Source: [Issue #<number>](<issue_url>) | ||||||
|
|
||||||
| ## Overview | ||||||
|
|
||||||
| This diagram shows the package structure and dependencies of the `gh-aw` codebase. | ||||||
|
|
||||||
| ``` | ||||||
| <ASCII diagram> | ||||||
| ``` | ||||||
|
|
||||||
| ## Package Reference | ||||||
|
|
||||||
| <package table> | ||||||
| ```` | ||||||
|
|
||||||
| - When the diagram **changes**: update `scratchpad/architecture.md` via `create_pull_request` with a PR titled `[architecture] Update architecture diagram - <date>`. | ||||||
|
||||||
| - When the diagram **changes**: update `scratchpad/architecture.md` via `create_pull_request` with a PR titled `[architecture] Update architecture diagram - <date>`. | |
| - When the diagram **changes**: update `scratchpad/architecture.md` via `create_pull_request` with a PR titled `Update architecture diagram - <date>`. |
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.
safe-outputs.create-pull-request.expires: 7is being compiled into the lockfile asexpires: 7(hours) rather than168(7 days). Since integers are documented as “days” forexpires, this likely makes the PR auto-expire after ~7 hours. Use an explicit duration like7d(or otherwise adjust) so the compiled lockfile reflects a 7‑day expiration.