Changelog test (bsc#1231235) #87
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Changelogs | |
| on: | |
| pull_request_target: | |
| types: [opened, edited, synchronize, reopened, closed] | |
| # Only execute on the main branches (feature branches are excluded) | |
| branches: | |
| - changelog-action | |
| - master | |
| # Uyuni patches | |
| - 'Uyuni-[0-9]+.[0-9]+' | |
| # SUSE Manager milestones | |
| - 'Manager-[0-9]+.[0-9]+-Alpha[0-9]?' | |
| - 'Manager-[0-9]+.[0-9]+-Beta[0-9]?' | |
| - 'Manager-[0-9]+.[0-9]+-RC[0-9]?' | |
| - 'Manager-[0-9]+.[0-9]+-GMC[0-9]?' | |
| - 'Manager-[0-9]+.[0-9]+-GM[0-9]?' | |
| # SUSE Manager releases | |
| - 'Manager-[0-9]+.[0-9]+' | |
| - 'Manager-[0-9]+.[0-9]+-MU-[0-9]+.[0-9]+.[0-9]+' | |
| # Only execute on directories that have changelogs | |
| paths: | |
| - 'branding/**' | |
| - 'client/**' | |
| - 'containers/**' | |
| - 'java/**' | |
| - 'projects/**' | |
| - 'proxy/**' | |
| - 'python/**' | |
| - 'reporting/**' | |
| - 'schema/**' | |
| - 'search-server/**' | |
| - 'selinux/**' | |
| - 'spacecmd/**' | |
| - 'spacewalk/**' | |
| - 'susemanager/**' | |
| - 'susemanager-branding-oss/**' | |
| - 'susemanager-sync-data/**' | |
| - 'susemanager-utils/**' | |
| - 'suseRegisterInfo/**' | |
| - 'tftpsync/**' | |
| - 'utils/**' | |
| - 'uyuni/**' | |
| - 'web/**' | |
| jobs: | |
| changelog_test: | |
| name: Changelog tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 1 | |
| filter: '.github/workflows/**' | |
| - id: master | |
| name: Get modified master changelog files | |
| uses: Ana06/get-changed-files@v2.3.0 | |
| with: | |
| filter: '*.changes' | |
| - name: Fail if the master changelog files are modified | |
| if: steps.master.outputs.all | |
| run: | | |
| echo "Master changelog files cannot be modified directly." | |
| echo "Please revert your changes on the following master changelog file(s):" | |
| for file in ${{steps.master.outputs.all}} | |
| do | |
| echo " - $file" | |
| done | |
| echo | |
| echo "See https://github.com/uyuni-project/uyuni/wiki/Contributing for a guide to writing changelogs." | |
| exit 1 | |
| - name: Checkout the HEAD branch | |
| id: checkout | |
| if: "!contains(github.event.pull_request.body, '[x] No changelog needed')" | |
| # Check out the PR HEAD in a subdirectory to read the diff for tests | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 1 | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| path: .head | |
| - name: Test changelog entries | |
| if: steps.checkout.outcome == 'success' | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BZ_TOKEN: ${{ secrets.BUGZILLA_TOKEN }} | |
| GIT_REPO: ${{ github.event.pull_request.base.repo.full_name }} | |
| PR_NUM: ${{ github.event.pull_request.number }} | |
| TRACKER_FILE: .github/workflows/changelogs/trackers.xml | |
| # Tracker file can be retrieved from the OBS/IBS API | |
| # by calling 'osc api /issue_trackers/' (with authentication) | |
| run: | | |
| pip install python-bugzilla~=3.2.0 | |
| ls -l . | |
| CHANGED_FILES=$(gh api --paginate repos/$GIT_REPO/pulls/$PR_NUM/files | jq -r '.[].filename') | |
| python .github/workflows/changelogs/changelogs.py ${RUNNER_DEBUG:+--verbose} \ | |
| --tracker-file $TRACKER_FILE --git-repo $GIT_REPO --uyuni-dir .head --pr-number $PR_NUM $CHANGED_FILES | |
| # Warns the user if they merged the PR, but the changelog test failed | |
| warn_user_if_merged: | |
| name: Warn user if merged | |
| if: always() && github.event.action == 'closed' && github.event.pull_request.merged == true && needs.changelog_test.result == 'failure' | |
| needs: changelog_test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Remind the author with a comment | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| issue-number: ${{ github.event.pull_request.number }} | |
| body: | | |
| :warning: Some changelog tests have failed. @${{ github.event.pull_request.user.login }}, please review and fix the changelog issues with an additional PR. |