pr-commit-body-action

KO | EN

gitlite — search

#javascript #ai #typescript #llm #android #machine-learning #rust #macos #nodejs #java #kubernetes #awesome-list #mcp #openai

pr-commit-body-action

(★ 13)

GitHub action to add commit history to PR body

pr-commit-body-action 최신버젼 다운로드

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PR Commit Body Action

[![CI Status](https://github.com/technote-space/pr-commit-body-action/workflows/CI/badge.svg)](https://github.com/technote-space/pr-commit-body-action/actions)
[![codecov](https://codecov.io/gh/technote-space/pr-commit-body-action/branch/master/graph/badge.svg)](https://codecov.io/gh/technote-space/pr-commit-body-action)
[![CodeFactor](https://www.codefactor.io/repository/github/technote-space/pr-commit-body-action/badge)](https://www.codefactor.io/repository/github/technote-space/pr-commit-body-action)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/technote-space/pr-commit-body-action/blob/master/LICENSE)

*Read this in other languages: [English](README.md), [日本語](README.ja.md).*

This is a `GitHub Actions` to add commit history to PR body.

## Table of Contents

<details>
<summary>Details</summary>

- [Screenshots](#screenshots)
  - [Auto generated body](#auto-generated-body)
- [Usage](#usage)
- [Options](#options)
- [Action event details](#action-event-details)
  - [Target events](#target-events)
- [Author](#author)

</details>

## Screenshots
### Auto generated body
![pr-body](https://raw.githubusercontent.com/technote-space/pr-commit-body-action/images/pr-body.png)

Part of the body of this PR (enclosed in red) is automatically generated by the merged PRs (enclosed in green) and commits (enclosed in blue).

## Usage
1. Setup workflow  
    e.g.
    ```yaml
    on:
      pull_request:
        types: [opened, synchronize]
    
    name: Pull Request updated
    
    jobs:
      history:
        name: Pull Request Body
        runs-on: ubuntu-latest
        if: startsWith(github.event.pull_request.head.ref, 'release/')
        steps:
          - name: Pull Request Body
            uses: technote-space/pr-commit-body-action@v1
    ```
1. Create pull request including comment below
    ```markdown
    
    
    ```

## Options
| name | description | default | required | e.g. |
|:---:|:---|:---:|:---:|:---:|
|CHANGE_TEMPLATE|Merge item template|`* ${TITLE} (#${NUMBER}) @${AUTHOR}`| |`- ${TITLE}`|
|COMMIT_TEMPLATE|Commit template|`* ${MESSAGE} (${COMMITS})`| |`- ${MESSAGE}`|
|MAX_COMMITS|Max number to show commits|`5`| |`3`|
|TEMPLATE|Template|`${MERGES}`<br>`${COMMITS}`<br>`${BREAKING_CHANGES}`|true|`${MERGES}`|
|COMMIT_TYPES|Types|`feat, fix, build, ci, docs, style, perf, refactor, test, chore`|true|`feat, fix, chore`|
|EXCLUDE_MESSAGES|Exclude messages| | |`tweaks`|
|TITLE|Title| | |`Changes:`|
|NO_ITEMS|Message to show if there are no item| | |`- no item`|
|LINK_ISSUE_KEYWORD|A keyword linking a pull request to issue.<br>If this options is set, this value is added to issue references.<br>(e.g. ` #234` => ` closes #123`)| | |`closes`|
|FILTER_PR|Whether to filter pull requests by semantic message rule|`false`| |`true`|
|GITHUB_TOKEN|Access token|`${{github.token}}`|true|`${{secrets.ACCESS_TOKEN}}`|

## Author
[GitHub (Technote)](https://github.com/technote-space)  
[Blog](https://technote.space)

pr-commit-body-action

pr-commit-body-action 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

pr-commit-body-action

pr-commit-body-action 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README