At a minimum you will need a jira project and this project expects that you will use Epics to plan your development. Additionally, you may filter more specifically within a project using labels.
A special label assumed to be in use is "long-term". When the "long-term" labels are used on epics it will separately display information about them from regular epics. The long-term epics are used to track work that seems to never end, e.g. Team Improvement, Documentation and Releases.
This project is still under active development (but usable). As such, the current usage experience is by installing and running from source code.
git clone https://github.com/rbrady/jira-roadmap.git cd jira-roadmap python -m venv .venv source .venv/bin/activate pip install -r requirements.txt
A minimum example to generate a report:
./roadmap.py --user MYUSERNAME --password MYPASSWORD --project MYPROJECT -l MYSQUAD --title "Team Roadmap"
Script argument details:
- This is the url for the Jira instance you're connecting to. The default is "https://projects.engineering.redhat.com".
- The name of the project in Jira. Example: "UPG"
- username for auth purposes to Jira
- password for auth purposes to Jira
- template', '-t'
- The jinja2 html template used to generate the report. There is a default template provided in the project at "templates/default_roadmap.j2".
- A file path for storing the generated report. It defaults to the current directory and the file name contains a timestamp.
- Labels are used in the JQL to filter issues coming from Jira.
- This argument allows you to skip specific issues.
- Custom JQL override. Instead of using the JQL in this script, use a completely custom JQL string as needed.
- Whether or not to verify the ssl certificate of the server when connecting to authenticate. Defaults to False.
- Use this argument to enable verbose output as needed.
- The title used in the html report. Defaults to "Roadmap".