Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reorder sections

...

Changelogs

Once you have made your first release, you should add  release notes to a changelog. You have many options how to do it:

  • use GitHub releases (possibly with the help of Release Drafter), add a link to releases page to your documentation page (recommended)
  • create a changelog file (Markdown, Asciidoc) in GitHub and link it from the documentation page
  • include the changelog content in the documentation page

...

Referencing the documentation page from the project file

You should link to your plugin's documentation, whether on the wiki or elsewhere, in your plugin's pom.xml, like this:

...

This ensures that the update center will list your plugin correctly once the new plugin version is released. If this is missing, or does not point to your Jenkins wiki page, your plugin will not be included in the update center.

Changelogs

Once you have made your first release, you should add  release notes to a changelog. You have many options how to do it:

  • use GitHub Releases (possibly with the help of Release Drafter), add a link to releases page to your documentation page (recommended)
  • create a changelog file (Markdown, Asciidoc) in GitHub and link it from the documentation page
  • include the changelog content in the documentation page

Adding Maintainer Information

...