kenjitayama / chglog

[WIP] pull-request crawler to generate the change-log

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Crawling pull-request with commit message and commit hash

Installation

yarn add chglog

Usage

Define a visitor

export interface Visitor {
  visitLabel(label: Label, source: PullRequest): void;
  visitAuthor(author: User, source: PullRequest): void;
}
const createSampleVistor = () => {
  return {
    visitLabel(label: Label, source: PullRequest) {
      ...
    },
    visitAuthor(author: User, source: PullRequest) {
      ...
    },   
};

Fetch and parse

const visitor = createSampleVistor();

await fetchData(
  {
    rightRef: '',
    leftRef: '',
    githubToken: '',
    repoOwner: '',
    repoName: '',
    workingDirectory: ''
  },
  visitor
);

About

[WIP] pull-request crawler to generate the change-log


Languages

Language:TypeScript 100.0%