Skip to content

Commit 047f2f7

Browse files
Merge pull request #351 from geturbackend/changelog/week-of-28793014654
docs: weekly changelog update
2 parents e97bd07 + 66db92b commit 047f2f7

7 files changed

Lines changed: 33 additions & 13 deletions

File tree

.github/scripts/generate-changelog-entry.js

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,29 +21,31 @@ Based on the following merged pull requests from the last 7 days, write a Mintli
2121
Merged PRs (${prCount} total):
2222
${prSummary}
2323
24-
Output ONLY the raw <Update> MDX block — no explanation, no markdown fences.
24+
Output ONLY the raw <Update> MDX block — no explanation.
2525
Use this exact format (matching the existing changelog style):
2626
2727
<Update label="${TODAY}" description="Week of ${WEEK_START}${TODAY}" tags={["Feature", "Improvement", "Fix"]}>
2828
## New features
2929
30-
**Feature name** — User-facing description.
30+
**Feature name** — User-facing description. ([#PR_NUMBER](https://github.com/geturbackend/urBackend/pull/PR_NUMBER) by [@username](https://github.com/username))
3131
3232
## Improvements
3333
34-
**Improvement name** — Description.
34+
**Improvement name** — Description. ([#PR_NUMBER](https://github.com/geturbackend/urBackend/pull/PR_NUMBER) by [@username](https://github.com/username))
3535
3636
## Bug fixes
3737
38-
- Fix description (#PR_NUMBER)
38+
- Fix description ([#PR_NUMBER](https://github.com/geturbackend/urBackend/pull/PR_NUMBER) by [@username](https://github.com/username))
3939
</Update>
4040
4141
Rules:
42-
- Only include sections (## New features / ## Improvements / ## Bug fixes) that have actual content.
43-
- Adjust the tags array to only include applicable tags from: "Feature", "Improvement", "Fix", "Security".
44-
- Write for developers using the platform, not the internal team.
45-
- Be concise and factual. Do not invent features not evidenced by the PRs.
46-
- If no PRs were merged, output: <Update label="${TODAY}" description="Week of ${WEEK_START}${TODAY}" tags={[]}>No significant changes this week.</Update>`;
42+
1. CRITICAL: Start your response EXACTLY with <Update and end with </Update>. Do NOT wrap your output in markdown code blocks (\`\`\`). Any extra text will break our pipeline.
43+
2. Ignore internal chores, dependency bumps, CI/CD updates, and test-only PRs. Only include changes that directly impact end-users or developers.
44+
3. For every item, include the PR number linked to its URL and the author linked to their GitHub profile.
45+
4. Only include sections (## New features / ## Improvements / ## Bug fixes) that have actual content.
46+
5. Adjust the tags array to only include applicable tags from: "Feature", "Improvement", "Fix", "Security".
47+
6. Write for developers using the platform, not the internal team. Be concise and factual. Do not invent features not evidenced by the PRs.
48+
7. If no PRs were merged (or if all were ignored), output: <Update label="${TODAY}" description="Week of ${WEEK_START}${TODAY}" tags={[]}>No significant changes this week.</Update>`;
4749

4850
const payload = JSON.stringify({
4951
model: "llama-3.3-70b-versatile",

.github/workflows/weekly-changelog.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,14 @@ jobs:
6767
- name: Prepend entry to current month's Mintlify changelog
6868
run: |
6969
MONTH=$(date --utc +%B | tr '[:upper:]' '[:lower:]')
70+
TITLE_MONTH=$(date --utc +%B)
7071
YEAR=$(date --utc +%Y)
7172
FILE="mintlify/docs/changelog/${MONTH}-${YEAR}.mdx"
7273
7374
# Create monthly file if it doesn't exist yet
7475
if [ ! -f "$FILE" ]; then
7576
echo "---" > "$FILE"
76-
echo "title: Changelog" >> "$FILE"
77+
echo "title: ${TITLE_MONTH} ${YEAR}" >> "$FILE"
7778
echo "description: What's new in urBackend — new features, improvements, and fixes." >> "$FILE"
7879
echo "---" >> "$FILE"
7980
echo "" >> "$FILE"

mintlify/docs/changelog/april-2026.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Changelog
2+
title: April 2026
33
description: What's new in urBackend — new features, improvements, and fixes.
44
---
55

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: July 2026
3+
description: What's new in urBackend — new features, improvements, and fixes.
4+
---
5+
6+
<Update label="2026-07-06" description="Week of 2026-06-29–2026-07-06" tags={["Feature", "Improvement"]}>
7+
## New features
8+
9+
**CLI Commands** — Three new CLI commands have been added to enhance user experience.
10+
**Rate Limiter** — A rate limiter has been added to the BullMQ worker to prevent abuse.
11+
12+
## Improvements
13+
14+
**Dashboard Redesign** — The dashboard has been redesigned with a persistent left sidebar and is now compatible with light mode.
15+
</Update>
16+

mintlify/docs/changelog/june-2026.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Changelog
2+
title: June 2026
33
description: What's new in urBackend — new features, improvements, and fixes.
44
---
55

mintlify/docs/changelog/may-2026.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Changelog (May 2026)
2+
title: May 2026
33
description: What's new in urBackend — new features, improvements, and fixes for May.
44
---
55

mintlify/docs/docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@
9393
{
9494
"group": "Changelog",
9595
"pages": [
96+
"changelog/july-2026",
9697
"changelog/may-2026",
9798
"changelog/june-2026",
9899
"changelog/april-2026"

0 commit comments

Comments
 (0)