NodeJS script to create Jira links for Jira macros embedded within Text Data macro (that were missing due to a Scaffolding bug) based on exported database data from Confluence.
- NodeJS 14 or higher needs to be installed. The latest LTS version is recommended.
- Jira and Confluence need to be accessible from the machine that is executing the script.
- The user whose credentials will be used to execute the script must have "Link Issues" permission for the target projects.
- If your Jira server uses any request rate limiters, DoS or brute-force protection (e.g. Fail2Ban, ModSecurity), ensure that the environment executing the script is whitelisted.
- As is the case with any bulk operation, test this script on a staging environment first.
- It is recommended to run this script at a period of low activity and traffic in the Jira server.
- A CSV extract of Jira links within Text Data macro is done. Execute
extract-jira-link-pages.sqlin your database and export the result set to a CSV file. The CSV file should be placed in the same folder as theindex.jsscript file.- If you are expecting very large results from the SQL query, you may paginate it by using
limitandoffsetto select the results in stages and export to separate CSV files. - You can then run the script once for each CSV file created.
- If you are expecting very large results from the SQL query, you may paginate it by using
- Before running the script for the first time, install the dependencies using
npm install. - Run
node index.js --help. Read the descriptions of the arguments and ensure you have them available. - Run:
node index.js --jira-url <jira base url> \
--conf-url <confluence base url> \
--csv <csv filename> \
--app-id <confluence app id> \
--jira-auth <username:password> \
--dry-runNOTE: If --dry-run is present, no HTTP requests will be sent and nothing will be updated. Useful to verify if the
CSV file is being parsed correctly.
- A timestamped log file will be saved in the same directory with a separate error log if any were encountered.