rapid-portal-release-notes v1.0.1

Release Notes

This /docs directory is essentially a separate project that builds and deploys release notes generated from JIRA data.

Uses Astro static site builder.

Setup

1. nvm use
2. npm install
3. Generate a JIRA API token
4. Create .env file

JIRA_email=
JIRA_token=
JIRA_server=zuarkb.atlassian.net

Adding a New Release

These pages are based on the Release Versions in JIRA. To add a page for a new release, create a new Release in JIRA and then follow the steps below.

Adding Custom Notes to a Release

To add custom copy to the top of a release note document open and edit src/notes/notes.js. Add a property for the release you want to edit and then add notes and breakingChanges properties to it with the content you want to add in Markdown format.

Generate Release Notes for All Releases in JIRA

1. npm run build

Publish Release Notes

1. npm run publish

Publishes to https://www.zuar.com/release-notes/rapid-portal