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
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ description: Optimize ReportPortal setup with customizable parameters - ports, s
| POSTGRES_USER | rpuser | API,UAT,MIGRATIONS | PostgreSQL user name |
| POSTGRES_PASSWORD | rppass | API,UAT,MIGRATIONS | PostgreSQL user password |
| POSTGRES_DB | reportportal | API,UAT,MIGRATIONS | PostgreSQL database name |
| RABBITMQ_DEFAULT_USER | rabbitmq | API,ANALYZER | PostgreSQL database name |
| RABBITMQ_DEFAULT_PASS | rabbitmq | API,ANALYZER | PostgreSQL database name |
| RABBITMQ_DEFAULT_USER | rabbitmq | API,ANALYZER | RabbitMQ Default user name |
| RABBITMQ_DEFAULT_PASS | rabbitmq | API,ANALYZER | RabbitMQ Default password |

[Example of docker compose](https://github.com/reportportal/reportportal/blob/master/docker-compose.yml) with filled out configuration parameters.
2 changes: 2 additions & 0 deletions docs/releases/Version26.0.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 3
sidebar_label: Version 26.0.1
last_update:
date: '2026-02-16'
---

# Version 26.0.1
Expand Down
2 changes: 2 additions & 0 deletions docs/releases/Version26.0.2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 2
sidebar_label: Version 26.0.2
last_update:
date: '2026-03-12'
---

# Version 26.0.2
Expand Down
2 changes: 2 additions & 0 deletions docs/releases/Version26.0.3.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 1
sidebar_label: Version 26.0.3
last_update:
date: '2026-05-29'
---

# Version 26.0.3
Expand Down
2 changes: 1 addition & 1 deletion docs/work-with-reports/TestCaseId.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Test case id is using for:

You can find a test case ID in the 'Edit' modal.

## How you can report items with Test case ID?
## How can you report items with Test case ID?

You can [report test case id via agents](https://github.com/reportportal/client-java/wiki/Test-case-ID).

Expand Down
33 changes: 32 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

import { themes } from 'prism-react-renderer';

const fs = require('fs');
const path = require('path');
const matter = require('gray-matter');

const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;

Expand All @@ -11,6 +15,28 @@ require('dotenv').config();
// the default baseUrl is for production deployment, for dev running specify it via DOCS_BASE_URL environment variable
const baseUrl = process.env.DOCS_BASE_URL || '/docs/';

const RELEASES_DIR = path.join(__dirname, 'docs', 'releases');

function readReleaseLastmodDates() {
const dates = {};
let files = [];
try {
files = fs.readdirSync(RELEASES_DIR);
} catch {
return dates;
}
for (const file of files) {
if (!file.endsWith('.md')) continue;
const { data } = matter.read(path.join(RELEASES_DIR, file));
const rawDate = data?.last_update?.date;
if (!rawDate) continue;
const date = new Date(rawDate);
if (Number.isNaN(date.getTime())) continue;
dates[path.basename(file, '.md')] = date.toISOString().split('T')[0];
}
return dates;
}

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'ReportPortal Documentation',
Expand Down Expand Up @@ -39,21 +65,26 @@ const config = {
sitemap: {
changefreq: 'weekly',
priority: 0.9,
lastmod: 'date',
ignorePatterns: ['/docs/search', '/docs/search/'],
filename: 'sitemap.xml',
createSitemapItems: async (params) => {
const { defaultCreateSitemapItems, ...rest } = params;
const items = await defaultCreateSitemapItems(rest);
const seen = new Set();
const fileExtensions = ['.html', '.htm', '.xml', '.pdf', '.jpg', '.png', '.css', '.js'];
const releaseLastmod = readReleaseLastmodDates();
return items
.map((item) => {
const u = new URL(item.url);
const hasFileExtension = fileExtensions.some(ext => u.pathname.endsWith(ext));
if (!hasFileExtension && !u.pathname.endsWith('/')) {
u.pathname += '/';
}
return { ...item, url: u.toString() };
const releaseMatch = u.pathname.match(/\/releases\/(Version[^/]+)\/?$/);
const releaseDate = releaseMatch ? releaseLastmod[releaseMatch[1]] : undefined;
const lastmod = releaseDate ?? item.lastmod;
return { ...item, url: u.toString(), lastmod };
})
.filter((item) => {
if (seen.has(item.url)) return false;
Expand Down
18 changes: 16 additions & 2 deletions scripts/update-release.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,20 @@ async function main() {
const sidebarPosition = readExistingSidebarPosition(filePath);
const sidebarLabel = buildSidebarLabel(releaseName);
const body = transformBody(release.body || '');
const lastUpdateDate = toDateOnly(release.published_at || release.created_at);

const content = [
const frontMatter = [
'---',
`sidebar_position: ${sidebarPosition}`,
`sidebar_label: ${sidebarLabel}`,
'---',
];
if (lastUpdateDate) {
frontMatter.push('last_update:', ` date: '${lastUpdateDate}'`);
}
frontMatter.push('---');

const content = [
...frontMatter,
'',
`# ${sidebarLabel}`,
'',
Expand All @@ -39,6 +47,12 @@ async function main() {
console.log(`Updated: ${fileName}`);
}

function toDateOnly(value) {
if (!value) return null;
const date = new Date(value);
return Number.isNaN(date.getTime()) ? null : date.toISOString().split('T')[0];
}

function readExistingSidebarPosition(filePath) {
if (!fs.existsSync(filePath)) return 1;
const text = fs.readFileSync(filePath, 'utf-8');
Expand Down
Loading