Skip to content

Commit

Permalink
rename action
Browse files Browse the repository at this point in the history
  • Loading branch information
dragonraid committed May 9, 2021
1 parent 9a65a5d commit a94d975
Show file tree
Hide file tree
Showing 4 changed files with 1,490 additions and 1,486 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# changelog-generator
# changelog-emitter

This github action fetches titles of pull requests between latest release and branch's HEAD and creates changelog from them.

## Inputs

| Input | Description | Example | Default | Required |
| :----- | ----------------------------------------: | --------------------: | ---------------------------------------------------------: | -------: |
| token | github personal access token | `ghe_xyz` | **NO DEFAULT PROVIDED** | yes |
| branch | base branch of pull request | `main` | repositories default branch | no |
| title | changelog title | `Changelog` | date `YYYY/MM/DD` | no |
| prefix | prefix of pull request title in changelog | `*` | `-` | no |
| owner | owner or organizatoin of repository | `dragonraid` | `GITHUB_REPOSITORY` environment variable (part before `/`) | no |
| repo | repository | `chnagelog-generator` | `GITHUB_REPOSITORY` environment variable (part after `/`) | no |
| Input | Description | Example | Default | Required |
| :----- | ----------------------------------------: | ------------------: | ---------------------------------------------------------: | -------: |
| token | github personal access token | `ghe_xyz` | **NO DEFAULT PROVIDED** | yes |
| branch | base branch of pull request | `main` | repositories default branch | no |
| title | changelog title | `Changelog` | date `YYYY/MM/DD` | no |
| prefix | prefix of pull request title in changelog | `*` | `-` | no |
| owner | owner or organization of repository | `dragonraid` | `GITHUB_REPOSITORY` environment variable (part before `/`) | no |
| repo | repository | `changelog-emitter` | `GITHUB_REPOSITORY` environment variable (part after `/`) | no |

## Output

Expand Down Expand Up @@ -42,7 +42,7 @@ jobs:

- name: Create changelog
id: changelog
uses: dragonraid/changelog-generator@v0.1.0
uses: dragonraid/changelog-emitter@v0.1.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}

Expand Down
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: changelog-generator
name: changelog-emitter
description: Github action for generating changelog out of pull requests
inputs:
branch:
Expand Down
Loading

0 comments on commit a94d975

Please sign in to comment.