{"id":15677557,"url":"https://github.com/technote-space/pr-commit-body-action","last_synced_at":"2025-05-06T22:23:36.602Z","repository":{"id":37002177,"uuid":"240185034","full_name":"technote-space/pr-commit-body-action","owner":"technote-space","description":"GitHub action to add commit history to PR body","archived":false,"fork":false,"pushed_at":"2023-12-24T09:06:07.000Z","size":8320,"stargazers_count":13,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-14T14:05:21.334Z","etag":null,"topics":["github-actions"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/technote-space.png","metadata":{"files":{"readme":"README.ja.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":"https://paypal.me/technote0space"}},"created_at":"2020-02-13T05:32:28.000Z","updated_at":"2023-07-21T14:57:40.000Z","dependencies_parsed_at":"2023-12-03T10:21:13.210Z","dependency_job_id":"68f49f0a-84ee-4ea5-8368-a7e157b1c581","html_url":"https://github.com/technote-space/pr-commit-body-action","commit_stats":{"total_commits":339,"total_committers":2,"mean_commits":169.5,"dds":0.4247787610619469,"last_synced_commit":"8870091c39236ad4e7e772a59c45dc68d76b066f"},"previous_names":[],"tags_count":175,"template":false,"template_full_name":"technote-space/gh-actions-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technote-space%2Fpr-commit-body-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technote-space%2Fpr-commit-body-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technote-space%2Fpr-commit-body-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/technote-space%2Fpr-commit-body-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/technote-space","download_url":"https://codeload.github.com/technote-space/pr-commit-body-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248978988,"owners_count":21192885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions"],"created_at":"2024-10-03T16:09:53.624Z","updated_at":"2025-04-19T10:32:01.256Z","avatar_url":"https://github.com/technote-space.png","language":"TypeScript","funding_links":["https://paypal.me/technote0space"],"categories":[],"sub_categories":[],"readme":"# PR Commit Body Action\n\n[![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)\n[![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)\n[![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)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/technote-space/pr-commit-body-action/blob/master/LICENSE)\n\n*Read this in other languages: [English](README.md), [日本語](README.ja.md).*\n\nプルリクエスト本文にコミット履歴を追加する`GitHub Actions`です。\n\n## Table of Contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\u003cdetails\u003e\n\u003csummary\u003eDetails\u003c/summary\u003e\n\n- [スクリーンショット](#%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88)\n  - [自動生成された本文](#%E8%87%AA%E5%8B%95%E7%94%9F%E6%88%90%E3%81%95%E3%82%8C%E3%81%9F%E6%9C%AC%E6%96%87)\n- [使用方法](#%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95)\n- [Options](#options)\n- [Action イベント詳細](#action-%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E8%A9%B3%E7%B4%B0)\n  - [対象イベント](#%E5%AF%BE%E8%B1%A1%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88)\n- [Author](#author)\n\n\u003c/details\u003e\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## スクリーンショット\n### 自動生成された本文\n![pr-body](https://raw.githubusercontent.com/technote-space/pr-commit-body-action/images/pr-body.png)\n\nこのプルリクエストの本文の一部（赤で囲まれている箇所）は、マージされたPR（緑で囲まれている箇所）とコミット（青で囲まれている箇所）によって自動的に生成されています。\n\n## 使用方法\n1. ワークフローを設定  \n    例：\n    ```yaml\n    on:\n      pull_request:\n        types: [opened, synchronize]\n    \n    name: Pull Request updated\n    \n    jobs:\n      history:\n        name: Pull Request Body\n        runs-on: ubuntu-latest\n        if: startsWith(github.event.pull_request.head.ref, 'release/')\n        steps:\n          - name: Pull Request Body\n            uses: technote-space/pr-commit-body-action@v1\n    ```\n1. 以下のコメントを含むプルリクエストを作成\n    ```markdown\n    \u003c!-- START pr-commits --\u003e\n    \u003c!-- END pr-commits --\u003e\n    ```\n\n## Options\n| name | description | default | required | e.g. |\n|:---:|:---|:---:|:---:|:---:|\n|CHANGE_TEMPLATE|マージされたプルリク用テンプレート|`* ${TITLE} (#${NUMBER}) @${AUTHOR}`| |`- ${TITLE}`|\n|COMMIT_TEMPLATE|コミット用テンプレート|`* ${MESSAGE} (${COMMITS})`| |`- ${MESSAGE}`|\n|MAX_COMMITS|最大コミット表示数|`5`| |`3`|\n|TEMPLATE|テンプレート|`${MERGES}`\u003cbr\u003e`${COMMITS}`\u003cbr\u003e`${BREAKING_CHANGES}`|true|`${MERGES}`|\n|COMMIT_TYPES|コミットタイプ|`feat, fix, build, ci, docs, style, perf, refactor, test, chore`|true|`feat, fix, chore`|\n|EXCLUDE_MESSAGES|除外メッセージ| | |`tweaks`|\n|TITLE|タイトル| | |`Changes:`|\n|NO_ITEMS|アイテムがない時に表示するメッセージ| | |`- no item`|\n|LINK_ISSUE_KEYWORD|プルリクエストを Issue に紐付けるためのキーワード\u003cbr\u003eこのオプションが設定されている場合、この値が Issue 参照に付与されます。\u003cbr\u003e(例：` #234` =\u003e ` closes #123`)| | |`closes`|\n|FILTER_PR|Semantic message のルールでプルリクエストをフィルタするかどうか|`false`| |`true`|\n|GITHUB_TOKEN|アクセストークン|`${{github.token}}`|true|`${{secrets.ACCESS_TOKEN}}`|\n\n## Action イベント詳細\n### 対象イベント\n| eventName | action |\n|:---:|:---:|\n|pull_request, pull_request_target|opened, reopened, synchronize|\n\n## Author\n[GitHub (Technote)](https://github.com/technote-space)  \n[Blog](https://technote.space)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechnote-space%2Fpr-commit-body-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftechnote-space%2Fpr-commit-body-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftechnote-space%2Fpr-commit-body-action/lists"}