Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions .github/scripts/generate-changelog-entry.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,31 @@ Based on the following merged pull requests from the last 7 days, write a Mintli
Merged PRs (${prCount} total):
${prSummary}

Output ONLY the raw <Update> MDX block — no explanation, no markdown fences.
Output ONLY the raw <Update> MDX block — no explanation.
Use this exact format (matching the existing changelog style):

<Update label="${TODAY}" description="Week of ${WEEK_START}–${TODAY}" tags={["Feature", "Improvement", "Fix"]}>
## New features

**Feature name** — User-facing description.
**Feature name** — User-facing description. ([#PR_NUMBER](https://github.com/geturbackend/urBackend/pull/PR_NUMBER) by [@username](https://github.com/username))

## Improvements

**Improvement name** — Description.
**Improvement name** — Description. ([#PR_NUMBER](https://github.com/geturbackend/urBackend/pull/PR_NUMBER) by [@username](https://github.com/username))

## Bug fixes

- Fix description (#PR_NUMBER)
- Fix description ([#PR_NUMBER](https://github.com/geturbackend/urBackend/pull/PR_NUMBER) by [@username](https://github.com/username))
</Update>

Rules:
- Only include sections (## New features / ## Improvements / ## Bug fixes) that have actual content.
- Adjust the tags array to only include applicable tags from: "Feature", "Improvement", "Fix", "Security".
- Write for developers using the platform, not the internal team.
- Be concise and factual. Do not invent features not evidenced by the PRs.
- If no PRs were merged, output: <Update label="${TODAY}" description="Week of ${WEEK_START}–${TODAY}" tags={[]}>No significant changes this week.</Update>`;
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.
2. Ignore internal chores, dependency bumps, CI/CD updates, and test-only PRs. Only include changes that directly impact end-users or developers.
3. For every item, include the PR number linked to its URL and the author linked to their GitHub profile.
4. Only include sections (## New features / ## Improvements / ## Bug fixes) that have actual content.
5. Adjust the tags array to only include applicable tags from: "Feature", "Improvement", "Fix", "Security".
6. Write for developers using the platform, not the internal team. Be concise and factual. Do not invent features not evidenced by the PRs.
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>`;

const payload = JSON.stringify({
model: "llama-3.3-70b-versatile",
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/weekly-changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,13 +67,14 @@ jobs:
- name: Prepend entry to current month's Mintlify changelog
run: |
MONTH=$(date --utc +%B | tr '[:upper:]' '[:lower:]')
TITLE_MONTH=$(date --utc +%B)
YEAR=$(date --utc +%Y)
FILE="mintlify/docs/changelog/${MONTH}-${YEAR}.mdx"

# Create monthly file if it doesn't exist yet
if [ ! -f "$FILE" ]; then
echo "---" > "$FILE"
echo "title: Changelog" >> "$FILE"
echo "title: ${TITLE_MONTH} ${YEAR}" >> "$FILE"
echo "description: What's new in urBackend — new features, improvements, and fixes." >> "$FILE"
echo "---" >> "$FILE"
echo "" >> "$FILE"
Expand Down
2 changes: 1 addition & 1 deletion mintlify/docs/changelog/april-2026.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Changelog
title: April 2026
description: What's new in urBackend — new features, improvements, and fixes.
---

Expand Down
16 changes: 16 additions & 0 deletions mintlify/docs/changelog/july-2026.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: July 2026
description: What's new in urBackend — new features, improvements, and fixes.
---

<Update label="2026-07-06" description="Week of 2026-06-29–2026-07-06" tags={["Feature", "Improvement"]}>
## New features

**CLI Commands** — Three new CLI commands have been added to enhance user experience.
**Rate Limiter** — A rate limiter has been added to the BullMQ worker to prevent abuse.

## Improvements

**Dashboard Redesign** — The dashboard has been redesigned with a persistent left sidebar and is now compatible with light mode.
</Update>
Comment thread
coderabbitai[bot] marked this conversation as resolved.

2 changes: 1 addition & 1 deletion mintlify/docs/changelog/june-2026.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Changelog
title: June 2026
description: What's new in urBackend — new features, improvements, and fixes.
---

Expand Down
2 changes: 1 addition & 1 deletion mintlify/docs/changelog/may-2026.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Changelog (May 2026)
title: May 2026
description: What's new in urBackend — new features, improvements, and fixes for May.
---

Expand Down
1 change: 1 addition & 0 deletions mintlify/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
{
"group": "Changelog",
"pages": [
"changelog/july-2026",
"changelog/may-2026",
"changelog/june-2026",
"changelog/april-2026"
Comment on lines +96 to 99

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Changelog pages list is out of chronological order.

The pages array reads july-2026, may-2026, june-2026, april-2026 — neither ascending nor descending order. This will make the changelog sidebar navigation confusing regardless of which direction (newest-first or oldest-first) is intended.

📅 Suggested fix (newest-first ordering)
             "pages": [
-              "changelog/july-2026",
-              "changelog/may-2026",
-              "changelog/june-2026",
-              "changelog/april-2026"
+              "changelog/july-2026",
+              "changelog/june-2026",
+              "changelog/may-2026",
+              "changelog/april-2026"
             ]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"changelog/july-2026",
"changelog/may-2026",
"changelog/june-2026",
"changelog/april-2026"
"changelog/july-2026",
"changelog/june-2026",
"changelog/may-2026",
"changelog/april-2026"
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@mintlify/docs/docs.json` around lines 96 - 99, The changelog pages array is
out of chronological order, making the sidebar inconsistent. Reorder the entries
in docs.json’s pages list under the changelog section using the existing month
page slugs so they are strictly chronological in the intended direction; keep
the ordering consistent across the list and verify the sequence around
july-2026, june-2026, may-2026, and april-2026.

Expand Down
Loading