Manually Generate Release Notes - SAP/fundamental-styles GitHub Wiki

This wiki is documenting how to generate release notes manually in case the script fails to generate them automatically. The Release Notes can be manually downloaded from the github api by following the below steps: Steps:

  1. Trigger a release(if this is not done already).

  2. Review the release list to see if the notes have been created. If they haven’t been created, continue to step 3.

  3. Open your local fundamental-styles project directory.

  4. Call npm run release:create -- --repo sap/fundamental-styles --tag v{{version}} --branch master , and replace the {{version}} with the new release version (ex. version 0.5.0 would look like npm run release:create -- --repo sap/fundamental-styles --tag v0.5.0 --branch master

  5. The script will try to fetch(GET) and transform the release notes and push(POST) them to repo. Once completed, a prepared message like the one below will appear on the console. Example Output: image

  6. When the POST method throws an error, the only way to add the release notes is to copy and paste them manually to the releases page. See the release notes for the 0.5.0 version for more details.