Frequently Asked Questions

How do relno-action know when to update the release note?

relno-action will check the release body to see if it contains <!-- Generate by Release Note -->. If it contains this comment, it will not update the release body. It means you can edit the release body manually after the release note is generated. This is useful when you want to add some extra information in the specify release.

Action failed with unknown revision or path not in the working tree error

This error is caused by actions/checkout action. You need to add fetch-depth: 0 to the actions/checkout action. actions/checkout will only fetch the commit which triggered the workflow by default. If you want to get the whole commit tree, you need to set fetch-depth manually. See actions/checkout.

- uses: actions/checkout@v3  with:    fetch-depth: 0