generate-pull-request-description

KO | EN

gitlite — search

#react #typescript #llm #golang #android #machine-learning #linux #docker #macos #nodejs #vue #pytorch #mcp #open-source

generate-pull-request-description

(★ 15)

A GitHub action that updates PR descriptions from Conventional Commits

generate-pull-request-description 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Release](https://github.com/octue/generate-pull-request-description/actions/workflows/release.yml/badge.svg)](https://github.com/octue/generate-pull-request-description/actions/workflows/release.yml)
[![codecov](https://codecov.io/gh/octue/generate-pull-request-description/branch/main/graph/badge.svg?token=J3NFSPZJHW)](https://codecov.io/gh/octue/generate-pull-request-description)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

# Pull request description generator
A GitHub action that generates pull request descriptions from
[Conventional Commit messages](https://www.conventionalcommits.org/en/v1.0.0/) on a branch. These descriptions can be
used with other GitHub actions to automate release notes.

**Features summary**
- Automatic breaking change highlighting and upgrade instructions
- Automatic categorisation of all commit messages in the pull request branch
- Choosing which part of the description to generate, enabling descriptions containing a generated section alongside
  static/user-written sections
- Easy skipping of description updating when you're ready to fine-tune and edit the description

## Usage
Add the action to pull request workflows alongside the
[`riskledger/update-pr-description`](https://github.com/riskledger/update-pr-description) action to dynamically update
the description each time you push:

```yaml
steps:
- uses: actions/checkout@v3

- uses: octue/generate-pull-request-description@1.0.0
  id: pr-description
  with:
    pull_request_url: ${{ github.event.pull_request.url }}
    api_token: ${{ secrets.GITHUB_TOKEN }}

- name: Update pull request body
  uses: riskledger/update-pr-description@v2
  with:
    body: ${{ steps.pr-description.outputs.pull_request_description }}
    token: ${{ secrets.GITHUB_TOKEN }}
```

## Features

### Breaking change highlighting
If breaking changes are indicated in any of the commit messages' bodies via `BREAKING CHANGE:` or `BREAKING-CHANGE:`,
these commits are marked and a warning is added to the top of the release notes. Any other text in these sections is
treated as upgrade instructions and added to the end of the pull request description.

### Choosing which section of the description to update
The only part of the pull request description that is updated by the action is the section bounded by:
- ``
- ``

This section will always be replaced with a summary of all the commit messages in the pull request so far. The markers
(invisible in rendered markdown) are added in automatically when the action first runs, but you can move them manually.
Any text you add outside of these will remain untouched so you can add, for example, your own static summary of the
pull request while having a dynamic summary of the commits.

### Skipping description updates
Updating the description is skipped if the `` marker is present anywhere in the pull
request description. This allows commits to be documented in the description until you're ready to fine-tune or
cherry-pick commit descriptions when your pull request is ready for review.

generate-pull-request-description

generate-pull-request-description 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

generate-pull-request-description

generate-pull-request-description 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README