feat: add changelog system #9134
Open
+1,819
−2,095
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🔴 🤖 Continuous IntegrationThis rule is failing.
🔴 👀 Review RequirementsThis rule is failing.
🔴 🔎 ReviewsThis rule is failing.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR descriptionWonderful, this rule succeeded.
|
jd
force-pushed
the
devs/jd/changelog/Ia2551cf70a6317a02376c287da41230680a05be4
branch
from
6ea2825 to
feed624
Compare
jd
force-pushed
the
devs/jd/changelog/Ia2551cf70a6317a02376c287da41230680a05be4
branch
from
feed624 to
25de18e
Compare
jd
force-pushed
the
devs/jd/changelog/Ia2551cf70a6317a02376c287da41230680a05be4
branch
from
25de18e to
3da1e76
Compare
|
@jd this pull request is now in conflict 😩 |
jd
force-pushed
the
devs/jd/changelog/Ia2551cf70a6317a02376c287da41230680a05be4
branch
from
3da1e76 to
2b4b8c7
Compare
jd
force-pushed
the
devs/jd/changelog/Ia2551cf70a6317a02376c287da41230680a05be4
branch
from
2b4b8c7 to
3af0637
Compare
|
@jd this pull request is now in conflict 😩 |
This implements a new changelog system to the docs so it's easy to browse it and subscribe via RSS. Fixes MRGFY-5981 Change-Id: Ia2551cf70a6317a02376c287da41230680a05be4
jd
force-pushed
the
devs/jd/changelog/Ia2551cf70a6317a02376c287da41230680a05be4
branch
from
3af0637 to
27c3b0f
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive changelog feature to the documentation site, allowing users to view and filter product updates directly within the docs.
- Adds a new
changelogcontent collection with schema validation for title, date, description, and tags - Implements utility functions for sorting, grouping, and formatting changelog entries
- Creates both an index page with filtering/search and individual detail pages for each changelog entry
- Integrates changelog into site navigation and updates internal links from external changelog
Reviewed Changes
Copilot reviewed 15 out of 17 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/util/changelog.ts | Utility functions for sorting, grouping, and formatting changelog entries |
| src/pages/changelog/index.astro | Main changelog page with search, filtering, and RSS subscription |
| src/pages/changelog/[slug].astro | Individual changelog entry detail page |
| src/pages/changelog/rss.xml.ts | RSS feed endpoint for changelog entries |
| src/content.config.ts | Adds changelog collection schema with validation |
| src/components/Breadcrumbs.astro | Adds breadcrumb support for changelog pages |
| src/layouts/MainLayout.astro | Makes headings optional and adds breadcrumbTitle prop |
| src/components/Header/Header.astro | Updates changelog link to internal page |
| src/components/Footer/footer.ts | Updates footer changelog link to internal page |
| src/components/Button.astro | Adds target prop with default '_blank' |
| src/components/Header/HeaderLink.astro | Adds target prop support |
| src/content/navItems.tsx | Adds changelog to navigation items |
| src/styles/index.css | Adds no-counter class to exclude elements from auto-numbering |
| package.json | Adds @astrojs/rss dependency |
| eslint.config.js | Excludes changelog content from linting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+6
to
+14
| export function sortChangelog( | ||
| entries: CollectionEntry<'changelog'>[] | ||
| ): CollectionEntry<'changelog'>[] { | ||
| return entries.sort((a, b) => { | ||
| const dateA = new Date(a.data.date); | ||
| const dateB = new Date(b.data.date); | ||
| return dateB.getTime() - dateA.getTime(); | ||
| }); | ||
| } |
There was a problem hiding this comment.
The sortChangelog function mutates the original array. Use entries.slice().sort() or [...entries].sort() to avoid side effects.
|
|
||
| <MainLayout content={{ title, description, suppressTitle: false }}> | ||
| <div class="changelog-header"> | ||
| <div class="search-wrap"> |
There was a problem hiding this comment.
The search input should have an associated label element (even if visually hidden) in addition to aria-label for better accessibility support across all assistive technologies.
Suggested change
| <div class="search-wrap"> | |
| <div class="search-wrap"> | |
| <label for="search" class="visually-hidden">Search changelog</label> |
| <span class="slack-text">Stay updated on Slack! Subscribe to get changelog updates in your workspace:</span> | ||
| </div> | ||
| <div class="slack-command"> | ||
| <code id="slack-command-text">/feed subscribe https://docs.mergify.com/changelog/rss.xml</code> |
There was a problem hiding this comment.
The hardcoded URL 'https://docs.mergify.com' should use context.site or be derived from configuration to ensure consistency across environments.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This implements a new changelog system to the docs so it's easy to
browse it and subscribe via RSS.
Fixes MRGFY-5981