Run the script locally - Fluid Topics

For the script to run, first follow the Prerequisites section.

To run the script locally:

Open a terminal.
Go to the path of the auto_rn_ft.py file.
Activate the virtual environment, if not done already.

For example:
```
source ./path-to-new-venv/bin/activate
```

Run the script.

For example:

python3 auto_rn_ft.py \
    --project "FT" \
    --version-prefix "5.2" \
    --title "My Product Release Notes"

The script takes the following arguments:

Long flag	Short flag	Required	Description
`--project`	`-p`	Yes	The Jira project key (for example, `FT` in `FT-0001`).
`--version-prefix`	`-v`	Yes	The version number used to label tickets in Jira (for example, `5.2` gets all versions starting with `5.2` such as `5.2.1`, `5.2.2`, etc.)
`--title`	`-t`	Yes	The title for the release notes document in Fluid Topics (for example, `"My Product Release Notes"`).
`--output`	`-o`	No	The name of the ZIP archive created by the script. If not provided, the name of the archive is `release_notes_{project}_{version}.zip`, where `{project}` and `{version}` are the `--project` and `--version-prefix` values.

The script downloads a .zip archive. It contains HTML release notes corresponding to each minor version of the major version set in the JIRA_FIX_VERSION_FIELD environment variable. All tickets are Done.

A map.ftmap file groups minor versions under a document corresponding to the major version. It also orders files from latest minor version to oldest.

Run the script locally - Fluid Topics - Latest

Automatic Release Notes from Jira to Fluid Topics