Example project using GitLab CI/CD for Allure report with history on GitLab Pages based on Java. This project exists only because of Aleksandr's Kotlyar work. I needed to use Java instead of Python, so I made myself some changes:
- project is Maven now;
- original generate_index file is on groovy;
- additional html and css style in order to have "Last modified" column in results.
- Enable Pages in your project
- In your main branch:
- Extend your
gitlab-ci.ymlwith stage "report" from this repo - Use image for this stage based on this Dockerfile
- Copy
generate_index.groovyscript into your main repo folder
- Extend your
- Create branch
gl-pages, it will be used for storing allure history- You can clean the whole branch from any files
- Clear current
gitlab-ci.yml - Create in the branch stage to publish Pages on Gitlab
Final results should be published on Gitlab Pages for each branch individually.
Note: Due to GitLab's policies, the personal access token I am using does not trigger the job, causing an error "The pipeline failed due to the user not being verified". I suspect the issue lies with my profile. Possible solutions include using your own dedicated runners instead of shared ones or a self-hosted GitLab instance. Or something else, it's not clear for me anyway.
- Job
testis running tests on your current branch and saves allure-results and JOB_ID to artifacts for the next job in pipeline. - Job
report:
- Clones
gl-pagesbranch with it's all content into container (saving all previous reports). - Gets the 'history' of the last build from the same branch (if exists) into 'allure-results' of current build.
- Creates 'executor.json' in 'allure-results' with build info and buildUrls in trends.
- Generates report with allure Commandline into job_number build folder.
- Creates branch-dir in 'gl-pages'
/publicdirectory if it's not existed yet. - Copies report into 'gl-pages'
/public/branchdirectory:/public/branch/job_number. - Generates the index files for page tree
/publicand/public/branch. - Commits and pushes the public directory into 'gl-pages' branch into the repo.
- And then push to branch 'gl-pages' triggers it's own job
pageswhich publishes all content from/publicdirectory on GitLab Pages.
All data can be accessed from the root link of GitLab Pages, where you can always see all the history of each branch and find the latest execution by the latest job_number inside the branch-dir of the branch you are interested in.