GitHub

Openchangelog offers deep integration with GitHub, allowing you to manage your release notes directly from your GitHub repository.
This ensures that you can easily keep your release notes up to date with the latest features of your project.

Here are a few key benefits of using GitHub as your source in Openchangelog:

• Version Control: Your release notes are versioned just like your code, so you can track changes and easily roll back if needed.
• Collaboration: Teams can collaborate on writing release notes directly in pull requests, ensuring that each feature or fix is properly documented.

Configuration

Add the github section to your openchangelog.yml config file. You can authenticate via a Github App or a Personal Access Token.

github:
  owner:
  repo:
  path:                 # to file or folder
  auth:
    accessToken:        # access token with a access to the specified repo
    # or
    appPrivateKey:      # path to private key
    appInstallationId:

Specify the path to either a single file (e.g., your CHANGELOG.md) or a folder. If you choose a folder, each file within it will be treated as a separate release note, as explained in our release note writing guide. For a single file, please use the Keep a Changelog format.