-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
feat: unified GitHub release, server change tracking, and enhanced release PR #3085
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
579248d
7755a05
98fc8b1
9532a8d
eff9377
dde60d6
9cbb740
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚩 show-release-summary still greps for '# Releases' heading which may not exist in the enhanced PR body At (Refers to line 46) Was this helpful? React with 👍 or 👎 to provide feedback. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # Server Changes | ||
|
|
||
| This directory tracks changes to server-only components (webapp, supervisor, coordinator, etc.) that are not captured by changesets. Changesets only track published npm packages — server changes would otherwise go undocumented. | ||
|
|
||
| ## When to add a file | ||
|
|
||
| **Server-only PRs**: If your PR only changes `apps/webapp/`, `apps/supervisor/`, `apps/coordinator/`, or other server components (and does NOT change anything in `packages/`), add a `.server-changes/` file. | ||
|
|
||
| **Mixed PRs** (both packages and server): Just add a changeset as usual. No `.server-changes/` file needed — the changeset covers it. | ||
|
|
||
| **Package-only PRs**: Just add a changeset as usual. | ||
|
|
||
| ## File format | ||
|
|
||
| Create a markdown file with a descriptive name: | ||
|
|
||
| ``` | ||
| .server-changes/fix-batch-queue-stalls.md | ||
| ``` | ||
|
|
||
| With this format: | ||
|
|
||
| ```markdown | ||
| --- | ||
| area: webapp | ||
| type: fix | ||
| --- | ||
|
|
||
| Speed up batch queue processing by removing stalls and fixing retry race | ||
| ``` | ||
|
|
||
| ### Fields | ||
|
|
||
| - **area** (required): `webapp` | `supervisor` | `coordinator` | `kubernetes-provider` | `docker-provider` | ||
| - **type** (required): `feature` | `fix` | `improvement` | `breaking` | ||
|
|
||
| ### Description | ||
|
|
||
| The body text (below the frontmatter) is a one-line description of the change. Keep it concise — it will appear in release notes. | ||
|
|
||
| ## Lifecycle | ||
|
|
||
| 1. Engineer adds a `.server-changes/` file in their PR | ||
| 2. Files accumulate on `main` as PRs merge | ||
| 3. The changeset release PR includes these in its summary | ||
| 4. After the release merges, CI cleans up the consumed files | ||
|
|
||
| ## Examples | ||
|
|
||
| **New feature:** | ||
|
|
||
| ```markdown | ||
| --- | ||
| area: webapp | ||
| type: feature | ||
| --- | ||
|
|
||
| TRQL query language and the Query page | ||
| ``` | ||
|
|
||
| **Bug fix:** | ||
|
|
||
| ```markdown | ||
| --- | ||
| area: webapp | ||
| type: fix | ||
| --- | ||
|
|
||
| Fix schedule limit counting for orgs with custom limits | ||
| ``` | ||
|
|
||
| **Improvement:** | ||
|
|
||
| ```markdown | ||
| --- | ||
| area: webapp | ||
| type: improvement | ||
| --- | ||
|
|
||
| Use the replica for API auth queries to reduce primary load | ||
| ``` |
Uh oh!
There was an error while loading. Please reload this page.