diff --git a/README.md b/README.md index 0522d7b..d877bb9 100644 --- a/README.md +++ b/README.md @@ -263,8 +263,8 @@ For advanced use cases additional settings can be provided to the action | `outputFile` | Optional relative path to a file to store the resulting changelog in. | | `owner` | The owner of the repository to generate the changelog for | | `repo` | Name of the repository we want to process | -| `fromTag` | Defines the 'start' from where the changelog will consider merged pull requests | -| `toTag` | Defines until which tag the changelog will consider merged pull requests | +| `fromTag` | Defines the 'start' from where the changelog will consider merged pull requests (can be a tag or a valid git ref) | +| `toTag` | Defines until which tag the changelog will consider merged pull requests (can be a tag or a valid git ref) | | `path` | Allows to specify an alternative sub directory, to use as base | | `token` | Alternative config to specify token. You should prefer `env.GITHUB_TOKEN` instead though | | `baseUrl` | Alternative config to specify base url for GitHub Enterprise authentication. Default value set to `https://api.github.com` | diff --git a/src/releaseNotes.ts b/src/releaseNotes.ts index bd5a075..9abbd56 100755 --- a/src/releaseNotes.ts +++ b/src/releaseNotes.ts @@ -214,7 +214,7 @@ export class ReleaseNotes { core.info(`ℹ️ Retrieved ${prCommits.length} commits for ${owner}/${repo}`) - return prCommits.map(function (commit) { + return prCommits.map(function (commit): PullRequestInfo { return { number: 0, title: commit.summary,