Skip to content

add new docs #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Arhell merged 1 commit into from
Jan 14, 2026
Merged

add new docs #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ export default defineConfig({
{ label: 'Import Cucumber BDD Tests', link: '/project/import-export/import/import-bdd'},
{ label: 'Import PHP Tests', link: '/project/import-export/import/import-php'},
{ label: 'Automated Import', link: '/project/import-export/import/auto-import'},
// { label: 'Java Check Tests', link: '/project/import-export/import/java-check-tests'},
{ label: 'Java Check Tests', link: '/project/import-export/import/java-check-tests'},
],
},
{
Expand Down Expand Up @@ -219,7 +219,7 @@ export default defineConfig({
{ label: 'Functions', link: '/test-reporting/functions'},
{ label: 'Reporting API', link: '/test-reporting/api'},
{ label: 'Logger', link: '/test-reporting/logger'},
// { label: 'Testomat.io Java Reporter', link: '/test-reporting/java-reporter'},
{ label: 'Testomat.io Java Reporter', link: '/test-reporting/java-reporter'},
{
label: 'Pipes',
collapsed: true,
Expand Down
35 changes: 10 additions & 25 deletions src/scripts/runok.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,37 +253,33 @@ ${content3}`)
},

async docsImporterJava() {
const destinationFolder = '../content/docs/project/import-export/import';
const destinationFolder = 'src/content/docs/project/import-export/import';
const imageFolder = path.join(destinationFolder, 'images');

// Ensure destination folders exist
if (!fs.existsSync(destinationFolder)) {
fs.mkdirSync(destinationFolder, {recursive: true});
fs.mkdirSync(destinationFolder, { recursive: true });
}

if (!fs.existsSync(imageFolder)) {
fs.mkdirSync(imageFolder, {recursive: true});
fs.mkdirSync(imageFolder, { recursive: true });
}

// Step 1: Download README.md from java-check-tests
const readmeUrl = 'https://raw.githubusercontent.com/testomatio/java-check-tests/main/README.md';
const response = await axios.get(readmeUrl);
let content = response.data.toString();

// Step 2: Remove the first Markdown H1 title (e.g., "# Java Check Tests")
content = content.replace(/^# .*\n+/, '');

// Step 3: Replace img/ with images/ in Markdown image paths
content = content.replace(/!\[(.*?)\]\((img\/.*?)\)/g, (match, alt, imgPath) => {
const imageName = path.basename(imgPath);
return `![${alt}](images/${imageName})`;
});

// Step 4: Add frontmatter and indentation
const frontmatter = `---
title: Java Check Tests
description: Java command-line tool for Testomat.io import Java test source code, sync test IDs (for JUnit/TestNG), and clean test annotations.
type: article
url: https://docs.testomat.io/project/import-export/import/java-check-tests
head:
- tag: meta
attrs:
Expand All @@ -292,22 +288,20 @@ head:
---\n\n`;
const finalContent = frontmatter + content;

// Step 5: Save the processed README.md as java-check-tests.md
const outputPath = path.join(destinationFolder, 'java-check-tests.md');
fs.writeFileSync(outputPath, finalContent);
console.log('✅ Saved java-check-tests.md');

// Step 6: Download the specific image: syncRunConsoleResult.png
const imageName = 'syncRunConsoleResult.png';
const imageUrl = `https://raw.githubusercontent.com/testomatio/java-check-tests/main/img/${imageName}`;
const imagePath = path.join(imageFolder, imageName);

try {
const imageResponse = await axios.get(imageUrl, {responseType: 'arraybuffer'});
const imageResponse = await axios.get(imageUrl, { responseType: 'arraybuffer' });
fs.writeFileSync(imagePath, imageResponse.data);
console.log(`🖼️ Downloaded image: ${imageName}`);
} catch (err) {
console.warn(`⚠️ Failed to download image: ${imageName}`, err.message);
console.warn(`⚠️ Failed to download image: ${imageName}, ${err.message}`);
}
},

Expand All @@ -317,10 +311,10 @@ head:
const branch = '1.x';
const readmeUrl = `https://raw.githubusercontent.com/${repo}/${branch}/README.md`;
const apiUrl = `https://api.github.com/repos/${repo}/contents/img?ref=${branch}`;
const destinationFolder = '../content/docs/test-reporting';

const destinationFolder = 'src/content/docs/test-reporting';
const imageFolder = path.join(destinationFolder, 'images');

// Ensure folders exist
if (!fs.existsSync(destinationFolder)) {
fs.mkdirSync(destinationFolder, { recursive: true });
}
Expand All @@ -329,44 +323,35 @@ head:
}

try {
// Step 1: Download README.md
const readmeResponse = await axios.get(readmeUrl);
let content = readmeResponse.data.toString();

// Step 2: Remove the first Markdown H1 title (e.g., "# Java Reporter")
content = content.replace(/^# .*\n+/, '');

// Step 3: Replace image paths in Markdown (img/ → images/)
content = content.replace(/!\[(.*?)\]\((img\/.*?)\)/g, (match, alt, imgPath) => {
const imageName = path.basename(imgPath);
return `![${alt}](images/${imageName})`;
});

// ✅ Step 3.1: Also replace relative ./img/ → ./images/
content = content.replace(/\.\/img\//g, './images/');

// Step 4: Prepend YAML front matter
const frontMatter = `---
title: Testomat.io Java Reporter
description: Official Java reporter for Testomat.io — integrates with JUnit, TestNG and Cucumber to auto-send test results, sync test IDs, support parametrized tests, artifacts (screenshots/logs), step-by-step reporting and collaborative team test-runs.
type: article
url: https://docs.testomat.io/test-reporting/java-reporter
head:
- tag: meta
attrs:
name: keywords
content: Testomat.io, Java reporter, JUnit, TestNG, Cucumber, test results, test management, test automation, test IDs sync, parametrized tests, test artifacts, step-by-step reporting, CLI tool, continuous integration, test run grouping
---

`;

---`;
content = frontMatter + content;

// Step 5: Save renamed README
const readmePath = path.join(destinationFolder, 'java-reporter.md');
fs.writeFileSync(readmePath, content);
console.log(`✅ Saved: ${readmePath}`);

// Step 6: Get image list from GitHub API and download them
const apiHeaders = typeof token !== 'undefined' ? { Authorization: `token ${token}` } : {};
const imageListResponse = await axios.get(apiUrl, { headers: apiHeaders });
const images = imageListResponse.data;
Expand Down