GitHub Actions

When using chango in your project, you will want to ensure that each change adds a change note. When hosted on GitHub, you can use GitHub Actions to support this process and automatically create a template change note for each new change. chango defines the following methods to help you with this process:

• chango.abc.ChanGo.build_github_event_change_note()

• chango.abc.ChangeNote.build_from_github_event()

Going even further, chango provides a composite GitHub Action that does the heavy lifting for you. You can configure it for example as follows:

name: Create Chango Change Note
on:
  pull_request:
    branches:
      - main
    types:
      - opened
      - reopened

jobs:
  create-chango-fragment:
    permissions:
      # Give the default GITHUB_TOKEN write permission to commit and push the
      # added chango note to the PR branch.
      contents: write
    name: create-chango-fragment
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
      - uses: Bibo-Joshi/chango@<sha-of-latest-release>
        with:
          # Optional: Specify a Python version to use
          python-version: '3.13'

This will automatically use your chango configuration to create a change note for each new change.

Inputs

The following inputs can be used to configure the action using the with keyword.

Name	Description	Required	Default
python-version	The Python version to use.	No	3.x
commit-and-push	Whether to commit and push the change note to the PR branch.	No	true
pyproject-toml	Path to the pyproject.toml file. Takes the same input as chango.config.get_chango_instance().	No	None