변경 로그 CI (작업을 사용하여 자동으로 생성된 변경 로그를 PR에 커밋 및/또는 주석)

내 워크플로우

나는 Changelog CI이라는 첫 번째 GitHub 시작 작업을 만들었다.
변경 로그를 생성하여 CHANGELOG.md 파일에 선행하고 게시 요청에 대한 제출 및/또는 주석을 지정하는 GitHub 작업입니다.
실례: Changelog CI's Changelog

제출 범주:

수리 인원은 반드시 갖추어야 한다

Yaml 파일 또는 코드 링크

다음은 Changelog CI의 링크입니다.
GitHub 저장소:

saadmk11 / 변경 로그ci

Changelog CI는 GitHub 작업으로 Changelog를 생성한 다음 Changelog를 게시 요청에 제출 및/또는 주석합니다.

Changelog CI란 무엇입니까?

Changelog CI는 Changelog를 생성하는 GitHub 작업입니다.
그런 다음 변경 로그를 CHANGELOG.md 파일로 선행하여 제출
및/또는 석방 요청에 대한 논평을 발표했습니다.

어떻게 작동하는지:

Changelog CI는 python 및 GitHub API을 사용하여 저장소에 Changelog 생성
먼저 저장소에서 latest release을 가져옵니다(사용 가능한 경우).
그런 다음 GitHub API를 사용하여 마지막으로 릴리즈된 모든 pull 요청을 확인합니다.
그 다음에 데이터를 분석하고 changelog을 생성합니다.마지막
이것은 생성된 변경 로그를 CHANGELOG.md (또는 사용자가 제공한 파일 이름) 파일의 시작 부분에 기록합니다.
또한 사용자가 프로필(JSON 파일)을 제공하는 경우 Changelog CI는 사용자가 제공한 프로필을 분석합니다.
사용자 설정에 따라 변경 로그를 표시합니다.
그리고 변경 사항을 방출 요청에 제출하거나 주석을 달습니다.

사용법:

이 동작을 사용하려면pull 요청을 실행하십시오...
View on GitHub
시장:
https://github.com/marketplace/actions/changelog-ci

추가 리소스/정보

Changelog CI은 새로운 개원 동작으로 지금까지 나의 개원 프로젝트는 모두 그것을 사용하고 있다.
예를 들어 django-newsfeed과 banking-system은 그것을 사용한다.
이 출력은 changelog-ci CHANGELOG.md을 사용하여 생성되었습니다.
Changelog CI 자체는 이 작업을 사용하여 Changelog을 생성합니다.

어떻게 작동하는지:

Changelog CI는 python 및 GitHub API을 사용하여 저장소에 Changelog를 생성합니다.
우선 저장소에서 latest release을 가져옵니다.
그런 다음 GitHub API를 사용하여 마지막으로 릴리즈된 모든 pull 요청을 확인합니다.그 다음에 데이터를 분석하고 changelog을 생성합니다.마지막으로 생성된 변경 로그는 CHANGELOG.md (또는 사용자가 제공한 파일 이름) 파일의 시작 부분에 기록됩니다.이외에도 사용자가 프로필(JSON 파일)을 제공하면 Changelog CI는 사용자가 제공한 프로필을 분석하고 사용자 프로필에 따라 Changelog를 보여줍니다.그리고 변경 사항을 제출하거나 방출 요청에 대한 의견을 발표합니다.

사용법:

이 작업을 사용하려면 요청 제목이 프로필의 기본 regex 또는 사용자가 제공한 regex과 일치해야 합니다.
기본 제목 정규 표현식: ^(?i)release (제목은 단어 "release"로 시작해야 합니다 (대/소문자 구분하지 않음)
기본 버전 번호 정규 표현식: SemVer (의미 버전 제어) 모드를 따릅니다.e, g.1.0.0, 1.0, v1.0.1 등.
의미 버전 제어 모드에 대한 자세한 내용은 다음 링크를 참조하십시오. https://regex101.com/r/Ly7O1x/3/
주: you can provide your own regex through the config file

Changelog CI를 사용한 워크플로우 예

name: Changelog CI

# Controls when the action will run. Triggers the workflow on pull request
on:
  pull_request:
    types: [opened, reopened]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      # Checks-out your repository
      - uses: actions/checkout@v2

      - name: Run Changelog CI
        uses: saadmk11/[email protected]
        with:
          # Optional, you can provide any name for your changelog file.
          # defaults to ``CHANGELOG.md`` if not provided.
          changelog_filename: CHANGELOG.md
          # Optional, only required when you want more customization
          config_file: changelog-ci-config.json
        env:
          # Optional, Only required for ``private`` repositories
          # and required if the changelog comment 
          # option is turned on through the config file
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

Changelog CI 엠블럼:

배지를 표시하려면 이 파일을 자술 파일에 추가합니다.

![Changelog CI Status](https://github.com/<username>/<repo_name>/workflows/Changelog%20CI/badge.svg)

구성 파일을 사용한 Changelog 출력 예:

Changelog CI 구성 파일에 대한 자세한 내용
README.md

버전: 0.0.2

빈틈 수리

#53: 끊임없이 업데이트

#54: 동일한 자술 파일을 다시 업데이트합니다: (

)

새로운 기능

#68: 자술을 갱신합니다.마리란드

문서 업데이트

#66: 문서 업데이트

버전: 0.0.1

빈틈 수리

#53: 끊임없이 업데이트

#54: 동일한 자술 파일을 다시 업데이트합니다: (

)

문서 업데이트

#66: 문서 업데이트

구성 파일을 사용하지 않는 Changelog 출력 예:

버전: 0.0.2

#53: 끊임없이 업데이트

#54: 동일한 자술 파일을 다시 업데이트합니다: (

)

#55: 자체 업데이트

버전: 0.0.1

#43: 감각 테스트가 끝난 적이 없음: (

)

#35:

반복 테스트

#44: 이것은 또 하나의 테스트입니다.

피곤합니다.

#37: 다른 테스트

Changelog CI가 실행 중(의견 및 제출)

결론

나는 이것이 개원 유지 보수 인원에게 매우 도움이 된다고 생각한다.관심 있는 사람이 있으면 Changelog CI을 시도하고 피드백을 남겨주세요:)