Skip to content

docs: document Allure 3 config flags (singleFile, reportLanguage, open, groupBy)#496

Open
MohabMohie wants to merge 1 commit into
masterfrom
codex/github-mention-allure-config-update
Open

docs: document Allure 3 config flags (singleFile, reportLanguage, open, groupBy)#496
MohabMohie wants to merge 1 commit into
masterfrom
codex/github-mention-allure-config-update

Conversation

@MohabMohie
Copy link
Copy Markdown
Contributor

Motivation

  • Surface and document Allure 3 (Awesome plugin) configuration options recently exposed by the engine so users can control packaging, language, browser-open behavior, and report grouping.
  • Provide file/CLI/code examples and defaults so users can set these options via custom.properties, Maven -D flags, or the SHAFT.Properties API.

Description

  • Add a new section to docs/Reporting/reporting.mdx documenting allure.singleFile, allure.reportLanguage, allure.open, and allure.groupBy with file-, CLI-, and code-based examples and recommended groupBy presets.
  • Update docs/Properties/PropertiesList.mdx to expose getters/setters and default values for the new Allure properties and add them to the defaults quick-reference table.
  • Update docs/Basic_Config/basicConfig.md to include example custom.properties entries showing allure.singleFile and allure.groupBy.
  • Add troubleshooting guidance for Allure CLI generation logs and note the distinction between SHAFT's allure.automaticallyOpen and the Allure CLI open flag.

Testing

  • Ran git diff --check -- docs/Basic_Config/basicConfig.md docs/Properties/PropertiesList.mdx docs/Reporting/reporting.mdx which produced no problems. (success)
  • Built the site with npm run build and the Docusaurus static build completed successfully, generating the build output. (success)

Codex Task

@netlify
Copy link
Copy Markdown

netlify Bot commented May 13, 2026

Deploy Preview for shaftengine ready!

Name Link
🔨 Latest commit d592605
🔍 Latest deploy log https://app.netlify.com/projects/shaftengine/deploys/6a0468e25733010008d3dd6c
😎 Deploy Preview https://deploy-preview-496--shaftengine.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 93
Accessibility: 93
Best Practices: 92
SEO: 100
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant