Skip to content

Commit

Permalink
Fixes #52: enhanced documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
anenviousguest committed Dec 1, 2023
1 parent a55d8be commit 612a0f9
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,19 @@ Additional Parameters:
The plugin is available on Maven central

## Note on release description
The easiest way of getting a good release description is to defer its generation to the GitHub. So if you completely leave out the `<description>` configuration
parameter, then GitHub will generate a meaningful description for you. Otherwise, if description _is_ supplied, it will be prepended to one generated by GitHub.
The easiest way of getting a good release description (aka release notes or changelog) is to defer its generation to the GitHub. So if you completely leave out
the `<description>` configuration parameter, then GitHub will generate a meaningful description for you. Otherwise, if description _is_ supplied, it will be
prepended to one generated by GitHub.

Below is an example of how the auto-generated release notes by GitHub could look like:

<img src="https://github.com/jutzig/github-release-plugin/assets/8439575/4e9479a5-a93d-420f-8153-06ad74ab48b7" width="500" alt="Screenshot of autogenerated GitHub release notes" />

You can read more about customizing the release notes format in the [GitHub documentation][github-release-notes-format]

## Note on the GitHub API endpoints
The endpoint for GitHub API is inferred from `<scm>` connection string. When missing, it by default would use the public endpoint at https://api.github.com.
If you want to upload to a GitHub enterprise instance, then a respective `<scm>` connection string must be specified.

<!-- Links, sorted alphabetically -->
[github-release-notes-format]: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes#configuring-automatically-generated-release-notes

0 comments on commit 612a0f9

Please sign in to comment.