https://github.com/technote-space/github-action-version-helper
Version helper for GitHub Actions.
https://github.com/technote-space/github-action-version-helper
github-actions
Last synced: 4 months ago
JSON representation
Version helper for GitHub Actions.
- Host: GitHub
- URL: https://github.com/technote-space/github-action-version-helper
- Owner: technote-space
- License: mit
- Created: 2020-02-25T13:51:39.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-12-25T09:00:59.000Z (over 2 years ago)
- Last Synced: 2025-03-26T23:39:00.803Z (about 1 year ago)
- Topics: github-actions
- Language: TypeScript
- Homepage:
- Size: 2.95 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.ja.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Github Action Version Helper
[](https://badge.fury.io/js/%40technote-space%2Fgithub-action-version-helper)
[](https://github.com/technote-space/github-action-version-helper/actions)
[](https://codecov.io/gh/technote-space/github-action-version-helper)
[](https://www.codefactor.io/repository/github/technote-space/github-action-version-helper)
[](https://github.com/technote-space/github-action-version-helper/blob/master/LICENSE)
*Read this in other languages: [English](README.md), [日本語](README.ja.md).*
GitHub Actions 用のバージョンヘルパー
## Table of Contents
Details
- [使用方法](#%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95)
- [Commit](#commit)
- [Version](#version)
- [Author](#author)
## 使用方法
1. インストール
* npm
`npm i @technote-space/github-action-version-helper`
* yarn
`yarn add @technote-space/github-action-version-helper`
1. 使用
```typescript
import { Commit, Version } from '@technote-space/github-action-version-helper';
```
### Commit
```typescript
import { Commit } from '@technote-space/github-action-version-helper';
...
const types = ['feat', 'chore'];
const excludeMessages = ['trigger workflow'];
const breakingChangeNotes = ['BREAKING CHANGE'];
const commits = await Commit.getCommits(types, excludeMessages, breakingChangeNotes, octokit, context);
/**
例：__tests__/fixtures/commit.list2.json
[
{
'type': 'chore',
'message': 'tweaks',
'normalized': 'chore: tweaks',
'original': 'chore: tweaks',
'children': [],
'notes': [],
'sha': '2dcb09b5b57875f334f61aebed695e2e4193db5e',
},
{
'type': 'feat',
'message': 'add new features',
'normalized': 'feat: add new features',
'original': 'feat!: add new features',
'children': [
{
'type': 'feat',
'message': 'add new feature1 (#123)',
'normalized': 'feat: add new feature1 (#123)',
'original': 'feat: add new feature1 (#123)',
},
{
'type': 'feat',
'message': 'add new feature2 (#234)',
'normalized': 'feat: add new feature2 (#234)',
'original': 'feat: add new feature2 (#234)',
},
],
'notes': ['BREAKING CHANGE: changed'],
'sha': '3dcb09b5b57875f334f61aebed695e2e4193db5e',
},
{
'type': 'feat',
'message': 'add new feature3',
'normalized': 'feat: add new feature3',
'original': 'feat : add new feature3',
'children': [],
'notes': [],
'sha': '4dcb09b5b57875f334f61aebed695e2e4193db5e',
},
{
'type': 'chore',
'message': 'tweaks',
'normalized': 'chore: tweaks',
'original': 'chore: tweaks',
'children': [],
'notes': [],
'sha': '9dcb09b5b57875f334f61aebed695e2e4193db5e',
},
]
**/
```
### Version
```typescript
import { Version } from '@technote-space/github-action-version-helper';
...
const minorUpdateCommitTypes = ['feat'];
const excludeMessages = ['tweaks'];
const breakingChangeNotes = ['BREAKING CHANGE'];
const version = await Version.getNextVersion(minorUpdateCommitTypes, excludeMessages, breakingChangeNotes, helper, octokit, context);
/**
例：__tests__/fixtures/repos.git.matching-refs.json, __tests__/fixtures/commit.list3.json
v2.1.0
**/
```
## Author
[GitHub (Technote)](https://github.com/technote-space)
[Blog](https://technote.space)