Skip to content
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.

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

Who can tell me how to use it #61

Open
shaozhb opened this issue Jan 15, 2025 · 3 comments
Open

Who can tell me how to use it #61

shaozhb opened this issue Jan 15, 2025 · 3 comments

Comments

@shaozhb
Copy link

shaozhb commented Jan 15, 2025

Who can tell me how to use it
I downloaded a bunch of packages using the 'npm add allure' command, but I don't know what to do next
I didn't get an answer from git, Google or chatgpt

@baev
Copy link
Member

baev commented Jan 15, 2025

There are multiple ways to use it.

At first, it's kind of the same as allure-commandline. To generate the report, you can use the allure classic path/to/allure-results or allure awesome path/to/allure-results commands.

Alternatively, you can also use the allure generate path/to/allure-results command and provide the config file (with no config file, it assumes you want to generate the Awesome report):

The example of the config file can be found here: https://github.com/allure-framework/allure3/blob/main/allurerc.mjs

The other option is to use allure run command. The run command will execute the specified command (e.g. if you run tests using the npm test command, you can use allure run -- npm test), automatically detect the test results and generate a report after all the tests are finished. The advantage of using allure run is that it can be configured to automatically rerun failed tests, ignore known failures and so on.

When the Allure configuration file is present, or the default directory is used for the report, you may use the allure open command to open the last generated report.

@DineshKumarRA
Copy link

@baev is it possible to configure allure3 in a maven-java project? If yes, do you have any example project with this configuration.

@ylazakovich
Copy link

ylazakovich commented Jan 16, 2025

@DineshKumarRA yes, you can

Look at workflow with example of building all version of allure report, including v3

https://github.com/eroshenkoam/allure-report-demo/blob/master/.github/workflows/build.yml

You need only allure-results and installed nodejs

Took this info from tg blog @eroshenkoam
https://t.me/eroshenqa/48

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants