docs: add monthly release notes #4358
Conversation
- Add dedicated release notes blog at /releases/ route - Configure Docusaurus blog plugin for release notes - Add navigation links in navbar and footer - Include comprehensive monthly roundups for March, April, and May 2025 - Set up RSS feed and SEO optimization for release notes - Add author configuration and publishing guidelines
There was a problem hiding this comment.
Pull Request Overview
This PR sets up the infrastructure and guidelines for monthly release roundups and adds new author metadata.
- Introduce
authors.ymlto list team members eligible to author release roundups - Add
site/releases/README.mdwith comprehensive guidelines for writing and structuring monthly roundups - Configure Docusaurus with a new “Release Notes” blog plugin and include March–May 2025 roundup posts
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| site/releases/authors.yml | New author metadata for monthly release roundups |
| site/releases/README.md | Guidelines for naming, structure, tone, and publishing process |
| site/releases/2025-03-31-march-roundup.md | Added March 2025 roundup |
| site/releases/2025-04-30-april-roundup.md | Added April 2025 roundup |
| site/releases/2025-05-31-may-roundup.md | Added May 2025 roundup |
| site/docusaurus.config.ts | Added “Release Notes” nav links and configured blog plugin id releases |
Comments suppressed due to low confidence (1)
site/releases/README.md:190
- The '## Authors' section currently has no entries. Consider listing the available author keys and names (from authors.yml) so contributors know which IDs to use.
## Authors
| name: Will Holley | ||
| title: Senior Engineer | ||
| url: https://github.com/promptfoo | ||
| image_url: /img/team/will.jpg |
There was a problem hiding this comment.
The file extension for Will Holley’s image is '.jpg' while others use '.jpeg'. Standardize on one extension to prevent broken image links or confusion.
| image_url: /img/team/will.jpg | |
| image_url: /img/team/will.jpeg |
Copilot uses AI. Check for mistakes.
mldangelo
changed the title
|
Handing this off to @ladyofcode to make it her own. |
|
⏩ No test scenarios generated (18780f6) View output ↗ Tip New to Tusk? Learn more here. |
WalkthroughA dedicated "Release Notes" blog section was added to the Docusaurus site configuration, including navigation links in the navbar and footer. New markdown documents were introduced for March, April, and May 2025 release roundups, along with a README for release roundup authoring guidelines and an authors metadata YAML file for the release notes section. Changes
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
npm error Exit handler never called! ✨ Finishing Touches
🧪 Generate Unit Tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
♻️ Duplicate comments (1)
site/releases/authors.yml (1)
61-65: 🛠️ Refactor suggestionStandardize image file extensions.
Will Holley’s image uses
.jpgwhile all other author images use.jpeg. To prevent broken links and maintain consistency, update to.jpeg:- image_url: /img/team/will.jpg + image_url: /img/team/will.jpeg
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (6)
site/docusaurus.config.ts(3 hunks)site/releases/2025-03-31-march-roundup.md(1 hunks)site/releases/2025-04-30-april-roundup.md(1 hunks)site/releases/2025-05-31-may-roundup.md(1 hunks)site/releases/README.md(1 hunks)site/releases/authors.yml(1 hunks)
🧰 Additional context used
🪛 LanguageTool
site/releases/README.md
[uncategorized] ~111-~111: When ‘Reference-specific’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...bers for major features when relevant - Reference specific version numbers within the roundup text...
(SPECIFIC_HYPHEN)
[style] ~136-~136: This phrase is redundant (‘O’ stands for ‘Optimization’). Use simply “SEO”.
Context: ...ays" statistics ## Best Practices ### SEO Optimization - Write descriptive titles with clear ...
(ACRONYM_TAUTOLOGY)
site/releases/2025-03-31-march-roundup.md
[uncategorized] ~193-~193: A determiner appears to be missing. Consider inserting it.
Context: ...ver Environment Enhancement (v0.107.0) Server now automatically loads .env files on s...
(AI_EN_LECTOR_MISSING_DETERMINER)
site/releases/2025-04-30-april-roundup.md
[uncategorized] ~73-~73: You might be missing the article “the” here.
Context: ... ### 📋 Enhanced LLM Rubric (v0.111.0) Modified LLM Rubric now supports arbitrary objec...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~201-~201: Possible missing comma found.
Context: ... functionality to specific rows in eval results with automatic scroll-to-top behavior f...
(AI_HYDRA_LEO_MISSING_COMMA)
site/releases/2025-05-31-may-roundup.md
[misspelling] ~121-~121: Did you mean the verb “intend” instead of the noun ‘intent’?
Context: ...g (v0.113.2, v0.113.3) Improvements to intent grading and gender bias detection for m...
(INTENT_INTEND)
[uncategorized] ~127-~127: Possible missing comma found.
Context: ...Side Pagination (v0.113.4) Performance improvement enabling handling of thousands of eval ...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
site/releases/README.md
9-9: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
site/releases/2025-04-30-april-roundup.md
12-12: Multiple top-level headings in the same document
null
(MD025, single-title, single-h1)
⏰ Context from checks skipped due to timeout of 90000ms (24)
- GitHub Check: Tusk Test Runner
- GitHub Check: Tusk Tester
- GitHub Check: Build Docs
- GitHub Check: Redteam Custom Enterprise Server
- GitHub Check: webui tests
- GitHub Check: Run Integration Tests
- GitHub Check: Share Test
- GitHub Check: Test on Node 24.x and ubuntu-latest
- GitHub Check: Test on Node 20.x and ubuntu-latest
- GitHub Check: Test on Node 24.x and macOS-latest
- GitHub Check: Test on Node 22.x and ubuntu-latest
- GitHub Check: Redteam
- GitHub Check: Test on Node 20.x and windows-latest
- GitHub Check: Test on Node 22.x and macOS-latest
- GitHub Check: Test on Node 20.x and macOS-latest
- GitHub Check: Test on Node 18.x and macOS-latest
- GitHub Check: Test on Node 18.x and windows-latest
- GitHub Check: Test on Node 18.x and ubuntu-latest
- GitHub Check: Build on Node 22.x
- GitHub Check: Build on Node 24.x
- GitHub Check: Build on Node 18.x
- GitHub Check: Build on Node 20.x
- GitHub Check: Style Check
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
site/releases/2025-05-31-may-roundup.md (1)
1-236: Well-structured May 2025 roundup.This document adheres to the release notes guidelines: front matter, metadata, admonitions, sections, code examples, and navigation links are all formatted correctly and consistently. No issues detected.
🧰 Tools
🪛 LanguageTool
[misspelling] ~121-~121: Did you mean the verb “intend” instead of the noun ‘intent’?
Context: ...g (v0.113.2, v0.113.3) Improvements to intent grading and gender bias detection for m...(INTENT_INTEND)
[uncategorized] ~127-~127: Possible missing comma found.
Context: ...Side Pagination (v0.113.4) Performance improvement enabling handling of thousands of eval ...(AI_HYDRA_LEO_MISSING_COMMA)
site/releases/2025-03-31-march-roundup.md (1)
1-191: Well-structured March 2025 roundup.Also applies to: 196-267
site/releases/2025-04-30-april-roundup.md (1)
1-71: Well-structured April 2025 roundup.Also applies to: 75-269
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Multiple top-level headings in the same document
null(MD025, single-title, single-h1)
site/releases/README.md (1)
112-112: 🧹 Nitpick (assertive)Compound adjective needs hyphen.
Under "Link to Resources," hyphenate "Reference-specific":
- Reference specific version numbers within the roundup text + Reference-specific version numbers within the roundup textLikely an incorrect or invalid review comment.
site/docusaurus.config.ts (1)
300-303: 🧹 Nitpick (assertive)Keep footer link style consistent with navbar
Same reasoning as above – use
toso Docusaurus treats the link as an internal route and keep styling consistent with the other footer items.- { - label: 'Release Notes', - to: '/releases/', - }, + { + label: 'Release Notes', + to: '/releases/', + },Likely an incorrect or invalid review comment.
| ### 🌐 Server Environment Enhancement (v0.107.0) | ||
|
|
||
| Server now automatically loads .env files on startup: | ||
|
|
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Add missing article for clarity.
In the "Server Environment Enhancement" section, prepend "the" before ".env files" for grammatical correctness:
- Server now automatically loads .env files on startup:
+ Server now automatically loads the .env files on startup:📝 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.
| ### 🌐 Server Environment Enhancement (v0.107.0) | |
| Server now automatically loads .env files on startup: | |
| ### 🌐 Server Environment Enhancement (v0.107.0) | |
| Server now automatically loads the .env files on startup: |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~193-~193: A determiner appears to be missing. Consider inserting it.
Context: ...ver Environment Enhancement (v0.107.0) Server now automatically loads .env files on s...
(AI_EN_LECTOR_MISSING_DETERMINER)
🤖 Prompt for AI Agents
In site/releases/2025-03-31-march-roundup.md around lines 192 to 195, add the
article "the" before ".env files" in the sentence "Server now automatically
loads .env files on startup" to improve grammatical clarity. Change the phrase
to "Server now automatically loads the .env files on startup."
| ### 📋 Enhanced LLM Rubric (v0.111.0) | ||
|
|
||
| Modified LLM Rubric now supports arbitrary objects for flexible eval criteria: |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Add definite article for clarity.
Modify the rubric intro sentence to include "The":
- Modified LLM Rubric now supports arbitrary objects for flexible eval criteria:
+ The modified LLM Rubric now supports arbitrary objects for flexible eval criteria:📝 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.
| ### 📋 Enhanced LLM Rubric (v0.111.0) | |
| Modified LLM Rubric now supports arbitrary objects for flexible eval criteria: | |
| ### 📋 Enhanced LLM Rubric (v0.111.0) | |
| The modified LLM Rubric now supports arbitrary objects for flexible eval criteria: |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: You might be missing the article “the” here.
Context: ... ### 📋 Enhanced LLM Rubric (v0.111.0) Modified LLM Rubric now supports arbitrary objec...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🤖 Prompt for AI Agents
In site/releases/2025-04-30-april-roundup.md around lines 72 to 74, the
introductory sentence for the LLM Rubric section is missing the definite article
"The" at the beginning. Edit the sentence to start with "The Modified LLM Rubric
now supports arbitrary objects for flexible eval criteria:" to improve clarity.
| ``` | ||
| YYYY-MM-DD-month-roundup.md | ||
| ``` |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Specify language for code fence.
Add a language identifier to this code block for improved readability and lint compliance:
- ```
+ ```text🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
9-9: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In site/releases/README.md around lines 9 to 11, the code block lacks a language
identifier, which affects readability and linting. Add the language identifier
"text" immediately after the opening triple backticks to specify the code block
language as plain text.
|
|
||
| ### SEO Optimization |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Simplify heading for brevity.
"SEO Optimization" is redundant; consider using "SEO":
- ### SEO Optimization
+ ### SEO🧰 Tools
🪛 LanguageTool
[style] ~136-~136: This phrase is redundant (‘O’ stands for ‘Optimization’). Use simply “SEO”.
Context: ...ays" statistics ## Best Practices ### SEO Optimization - Write descriptive titles with clear ...
(ACRONYM_TAUTOLOGY)
🤖 Prompt for AI Agents
In site/releases/README.md at lines 135 to 136, the heading "SEO Optimization"
is redundant. Change the heading to simply "SEO" to make it more concise and
clear.
| { | ||
| href: '/releases/', | ||
| label: 'Release Notes', | ||
| }, |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Prefer to over href for internal routes
Within Docusaurus config objects, to is the canonical field for internal navigation, while href is intended for external URLs.
Using href here will still work, but it bypasses Docusaurus’ internal link handling (trailing-slash normalization, baseUrl prefixing, i18n, etc.) and is easy to forget when refactoring.
- {
- href: '/releases/',
- label: 'Release Notes',
- },
+ {
+ to: '/releases/',
+ label: 'Release Notes',
+ },📝 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.
| { | |
| href: '/releases/', | |
| label: 'Release Notes', | |
| }, | |
| { | |
| to: '/releases/', | |
| label: 'Release Notes', | |
| }, |
🤖 Prompt for AI Agents
In site/docusaurus.config.ts around lines 150 to 153, replace the `href`
property with `to` for the internal route '/releases/'. This change ensures
Docusaurus handles the link correctly with features like trailing-slash
normalization and baseUrl prefixing. Update the object key from `href` to `to`
while keeping the same path string.
| [ | ||
| '@docusaurus/plugin-content-blog', | ||
| { | ||
| id: 'releases', | ||
| routeBasePath: 'releases', | ||
| path: './releases', | ||
| blogTitle: 'Release Notes', | ||
| blogDescription: 'promptfoo release notes and updates', | ||
| blogSidebarCount: 10, | ||
| blogSidebarTitle: 'Recent Releases', | ||
| postsPerPage: 10, | ||
| showReadingTime: false, | ||
| feedOptions: { | ||
| type: 'all', | ||
| title: 'promptfoo Release Notes', | ||
| description: 'Stay updated with the latest promptfoo releases', | ||
| copyright: `© ${new Date().getFullYear()} promptfoo`, | ||
| language: 'en', | ||
| }, | ||
| editUrl: 'https://github.com/promptfoo/promptfoo/tree/main/site', | ||
| }, | ||
| ], |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Add authors map & tighten path resolution for the new blog instance
- If you intend to use the
authors.ymlintroduced insite/releases, wire it into the plugin viaauthorsMapPath; otherwise author data will be ignored. - Resolving the content path with
path.resolve(__dirname, 'releases')is slightly safer (no chance of accidental CWD changes during builds).
- {
- id: 'releases',
- routeBasePath: 'releases',
- path: './releases',
+ {
+ id: 'releases',
+ routeBasePath: 'releases',
+ path: path.resolve(__dirname, 'releases'),
+ authorsMapPath: path.resolve(__dirname, 'releases', 'authors.yml'),Everything else in the block looks solid (pagination, feed options, etc.).
Ensure the build can locate authors.yml after this change.
🏁 Script executed:
#!/bin/bash
# Locate authors.yml anywhere in the repository
find . -type f -name "authors.yml"
# Verify that `path` is imported in the Docusaurus config
grep -n "import path" site/docusaurus.config.ts || echo "No 'import path' found in site/docusaurus.config.ts"Length of output: 255
Add authorsMapPath & tighten path resolution for the releases blog plugin
To wire in your authors.yml and guard against CWD changes, update site/docusaurus.config.ts as follows:
- At the top of the file, add the
pathimport:import path from 'path';
- In the
@docusaurus/plugin-content-blogblock forid: 'releases', replace:- path: './releases', + path: path.resolve(__dirname, 'releases'), + authorsMapPath: path.resolve(__dirname, 'releases', 'authors.yml'),
This ensures the build will reliably locate site/releases/authors.yml during plugin initialization.
🤖 Prompt for AI Agents
In site/docusaurus.config.ts around lines 636 to 657, import the 'path' module
at the top of the file if not already imported. Then, in the
'@docusaurus/plugin-content-blog' configuration for the 'releases' blog, update
the 'path' property to use path.resolve(__dirname, 'releases') instead of a
relative string. Also, add the 'authorsMapPath' property pointing to
path.resolve(__dirname, 'releases/authors.yml') to ensure the authors.yml file
is correctly wired into the plugin. This will make the content path resolution
more robust and enable author data usage.
No description provided.