Apr 19, 2025 · Apr 14, 2025 · Apr 14, 2025 · Apr 14, 2025 · Apr 14, 2025 · Apr 19, 2025
diff --git a/.github/workflows/chango.yml b/.github/workflows/chango.yml
 name: Chango
 on:
  pull_request:
    types:
      - opened
      - reopened
      - synchronize

 permissions: {}

 jobs:
  create-chango-fragment:
    permissions:
      # Give the default GITHUB_TOKEN write permission to commit and push the
      # added or changed files to the repository.
      contents: write
    name: Create chango Fragment
    runs-on: ubuntu-latest
    outputs:
      IS_RELEASE_PR: ${{ steps.check_title.outputs.IS_RELEASE_PR }}

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          # needed for commit and push step at the end
          persist-credentials: true
      - name: Check PR Title
        id: check_title
        run: | # zizmor: ignore[template-injection]
          if [[ "$(echo "${{ github.event.pull_request.title }}" | tr '[:upper:]' '[:lower:]')" =~ ^bump\ version\ to\ .* ]]; then
            echo "COMMIT_AND_PUSH=false" >> $GITHUB_OUTPUT
            echo "IS_RELEASE_PR=true" >> $GITHUB_OUTPUT
          else
            echo "COMMIT_AND_PUSH=true" >> $GITHUB_OUTPUT
            echo "IS_RELEASE_PR=false" >> $GITHUB_OUTPUT
          fi

      # Create the new fragment
      - uses: Bibo-Joshi/chango@9d6bd9d7612eca5fab2c5161687011be59baaf19 # v0.4.0
        with:
          github-token: ${{ secrets.CHANGO_PAT }}
          query-issue-types: true
          commit-and-push: ${{ steps.check_title.outputs.COMMIT_AND_PUSH }}

      # Run `chango release` if applicable - needs some additional setup.
      - name: Set up Python
        if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
        with:
          python-version: "3.x"

      - name: Do Release
        if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
        run: |
          cd ./target-repo
          git add changes/unreleased/*
          pip install . -r docs/requirements-docs.txt
          VERSION_TAG=$(python -c "from telegram import __version__; print(f'{__version__}')")
          chango release --uid $VERSION_TAG

      - name: Commit & Push
        if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
        uses: stefanzweifel/git-auto-commit-action@e348103e9026cc0eee72ae06630dbe30c8bf7a79 # v5.1.0
        with:
          commit_message: "Do chango Release"
          repository: ./target-repo
diff --git a/.github/workflows/chango_fragment.yml b/.github/workflows/chango_fragment.yml
diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml
      actions: read  # for downloading artifacts

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false
      - name: Download all the dists
        uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
        with:
    permissions: {}

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false
      - name: Publish to Telegram Channel
        env:
          TAG: ${{ needs.build.outputs.TAG }}
diff --git a/.github/workflows/release_test_pypi.yml b/.github/workflows/release_test_pypi.yml
      actions: read  # for downloading artifacts

    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          persist-credentials: false
      - name: Download all the dists
        uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
        with:
diff --git a/changes/config.py b/changes/config.py
 # pylint: disable=import-error
 """Configuration for the chango changelog tool"""

 import re
 from collections.abc import Collection
 from pathlib import Path
 from typing import Optional

 from chango import Version
 from chango.concrete import DirectoryChanGo, DirectoryVersionScanner, HeaderVersionHistory
 from chango.concrete.sections import GitHubSectionChangeNote, Section, SectionVersionNote

        return found or {"other"}


 chango_instance = DirectoryChanGo(
 class CustomChango(DirectoryChanGo):
    """Custom ChanGo class for overriding release"""

    def release(self, version: Version) -> bool:
        """replace "14.5" with version.uid except in the contrib guide
        then call super
        """
        root = Path(__file__).parent.parent / "telegram"
        python_files = root.rglob("*.py")
        pattern = re.compile(r"NEXT\.VERSION")
        excluded_paths = {root / "docs/source/contribute.rst"}
        for file_path in python_files:
            if str(file_path) in excluded_paths:
                continue

            content = file_path.read_text(encoding="utf-8")
            modified = pattern.sub(version.uid, content)

            if content != modified:
                file_path.write_text(modified, encoding="utf-8")

        return super().release(version)


 chango_instance = CustomChango(
    change_note_type=ChangoSectionChangeNote,
    version_note_type=SectionVersionNote,
    version_history_type=HeaderVersionHistory,
diff --git a/changes/unreleased/4758.dSyCdBJWEJroH2GynR2VaJ.toml b/changes/unreleased/4758.dSyCdBJWEJroH2GynR2VaJ.toml
 internal = "Fine Tune ``chango`` and Release Workflows"
 [[pull_requests]]
 uid = "4758"
 author_uid = "Bibo-Joshi"
 closes_threads = ["4720"]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,66 @@
		name: Chango
		on:
		pull_request:
		types:
		- opened
		- reopened
		- synchronize

		permissions: {}

		jobs:
		create-chango-fragment:
		permissions:
		# Give the default GITHUB_TOKEN write permission to commit and push the
		# added or changed files to the repository.
		contents: write
		name: Create chango Fragment
		runs-on: ubuntu-latest
		outputs:
		IS_RELEASE_PR: ${{ steps.check_title.outputs.IS_RELEASE_PR }}

		steps:
		- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
		with:
		# needed for commit and push step at the end
		persist-credentials: true
		- name: Check PR Title
		id: check_title
		run: \| # zizmor: ignore[template-injection]
		if [[ "$(echo "${{ github.event.pull_request.title }}" \| tr '[:upper:]' '[:lower:]')" =~ ^bump\ version\ to\ .* ]]; then
		echo "COMMIT_AND_PUSH=false" >> $GITHUB_OUTPUT
		echo "IS_RELEASE_PR=true" >> $GITHUB_OUTPUT
		else
		echo "COMMIT_AND_PUSH=true" >> $GITHUB_OUTPUT
		echo "IS_RELEASE_PR=false" >> $GITHUB_OUTPUT
		fi

		# Create the new fragment
		- uses: Bibo-Joshi/chango@9d6bd9d7612eca5fab2c5161687011be59baaf19 # v0.4.0
		with:
		github-token: ${{ secrets.CHANGO_PAT }}
		query-issue-types: true
		commit-and-push: ${{ steps.check_title.outputs.COMMIT_AND_PUSH }}

		# Run `chango release` if applicable - needs some additional setup.
		- name: Set up Python
		if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
		uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
		with:
		python-version: "3.x"

		- name: Do Release
		if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
		run: \|
		cd ./target-repo
		git add changes/unreleased/*
		pip install . -r docs/requirements-docs.txt
		VERSION_TAG=$(python -c "from telegram import __version__; print(f'{__version__}')")
		chango release --uid $VERSION_TAG

		- name: Commit & Push
		if: steps.check_title.outputs.IS_RELEASE_PR == 'true'
		uses: stefanzweifel/git-auto-commit-action@e348103e9026cc0eee72ae06630dbe30c8bf7a79 # v5.1.0
		with:
		commit_message: "Do chango Release"
		repository: ./target-repo
Original file line number	Diff line number	Diff line change
Expand Up		@@ -110,6 +110,9 @@ jobs:
		actions: read # for downloading artifacts

		steps:
		- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
		with:
		persist-credentials: false
		- name: Download all the dists
		uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
		with:
Expand DownExpand Up		@@ -150,6 +153,9 @@ jobs:
		permissions: {}

		steps:
		- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
		with:
		persist-credentials: false
		- name: Publish to Telegram Channel
		env:
		TAG: ${{ needs.build.outputs.TAG }}
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -112,6 +112,9 @@ jobs:
		actions: read # for downloading artifacts

		steps:
		- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
		with:
		persist-credentials: false
		- name: Download all the dists
		uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4.2.1
		with:
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,9 +2,12 @@
		# pylint: disable=import-error
		"""Configuration for the chango changelog tool"""

		import re
		from collections.abc import Collection
		from pathlib import Path
		from typing import Optional

		from chango import Version
		from chango.concrete import DirectoryChanGo, DirectoryVersionScanner, HeaderVersionHistory
		from chango.concrete.sections import GitHubSectionChangeNote, Section, SectionVersionNote

Expand DownExpand Up		@@ -70,7 +73,31 @@ def get_sections(
		return found or {"other"}


		chango_instance = DirectoryChanGo(
		class CustomChango(DirectoryChanGo):
		"""Custom ChanGo class for overriding release"""

		def release(self, version: Version) -> bool:
		"""replace "14.5" with version.uid except in the contrib guide
		then call super
		"""
		root = Path(__file__).parent.parent / "telegram"
		python_files = root.rglob("*.py")
		pattern = re.compile(r"NEXT\.VERSION")
		excluded_paths = {root / "docs/source/contribute.rst"}
		for file_path in python_files:
		if str(file_path) in excluded_paths:
		continue

		content = file_path.read_text(encoding="utf-8")
		modified = pattern.sub(version.uid, content)

		if content != modified:
		file_path.write_text(modified, encoding="utf-8")

		return super().release(version)


		chango_instance = CustomChango(
		change_note_type=ChangoSectionChangeNote,
		version_note_type=SectionVersionNote,
		version_history_type=HeaderVersionHistory,
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,5 @@
		internal = "Fine Tune ``chango`` and Release Workflows"
		[[pull_requests]]
		uid = "4758"
		author_uid = "Bibo-Joshi"
		closes_threads = ["4720"]