Apache Maven Distribution Tool
Maven Distribution Tool is a tool executed daily on Maven CI server to produce a report of the different checks done on our releases.
mvn verify site
The API_TOKEN environment variable is needed by the two Jenkins reports (list-master-jobs and
list-branches), since ci-maven.apache.org doesn't allow anonymous access to its JSON API.
It is a Base64-encoded username:apitoken string used for HTTP Basic Authentication.
Everything else (gitbox, maven.apache.org, dist/archive.apache.org, lists.apache.org) is read anonymously. Without the token the two reports skip Jenkins and render a page saying the token is missing.
- Log in to the Apache Jenkins instance.
- Click your username in the top-right corner to open your user profile.
- Navigate to Security (or go directly to
https://ci-maven.apache.org/user/<your-username>/security/). - Under API Token, click Add new Token, give it a name, and click Generate.
- Copy the generated token — it will not be shown again.
- Press Save to store generated token.
To verify the created token got stored correctly, log out and in again and check if the token is listed on the Security page. If the token did not get stored, hit Terminate all sessions. This will log you out. Then repeat the steps above.
Base64-encode your Jenkins username and API token, then export it:
export API_TOKEN=$(echo -n 'your-username:your-api-token' | base64)You can add this to your shell profile (~/.bashrc, ~/.zshrc, etc.) for persistence.
On Windows, you can use the following CMD command to encode it:
powershell "[convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes(\"your-username:your-api-token\"))"
After encoding store it in your environment variables using the following CMD command:
setx API_TOKEN your-Base64-encoded-token /m
Alternatively, configure the variable through the graphical interface.
Navigate to Settings → System → About → Advanced system settings → Environment Variables, or search for Environment Variables using the Windows search bar.
- Local build with site reports:
mvn verify site— the reports useAPI_TOKENto fetch data from Jenkins. - Integration tests:
mvn failsafe:integration-test— the token is passed to the failsafe plugin via theAPI_TOKENenvironment variable. - CI (Jenkins): The token is automatically injected via the
withCredentialsbinding in theJenkinsfileusing theAPI_TOKENcredential ID.