Github Action Version Helper
Read this in other languages: English, 日本語.
Version helper for GitHub Actions.
Table of Contents
Usage
- Install
- npm
npm i @technote-space/github-action-version-helper - yarn
yarn add @technote-space/github-action-version-helper
- npm
- Use
import { Commit, Version } from '@technote-space/github-action-version-helper';Commit
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);
/**
e.g. __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
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);
/**
e.g. __tests__/fixtures/repos.git.matching-refs.json, __tests__/fixtures/commit.list3.json
v2.1.0
**/