Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
yanamura committed May 10, 2020
1 parent 0cd3373 commit 0dc7c3a
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Git Merge Diff

This action generate git merge diff between tags.

# Usage

```yaml
- uses: actions/checkout@v2
- run: git fetch --prune --unshallow
- name: Diff
id: diff
uses: yanamura/git-merge-diff@v1
```
> Note: don't forget to fetch.(actions/checkout only fetch depth=0)
## get output(merge diff)
```
steps.<step id>.outputs.diff
```

# Senario

```yaml
- uses: actions/checkout@v2
- run: git fetch --prune --unshallow
- name: Diff
id: diff
uses: yanamura/git-merge-diff@v1
- name: Create Release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
release_name: Release ${{ github.ref }}
body: |
${{ steps.diff.outputs.diff }}
draft: false
prerelease: false
```

0 comments on commit 0dc7c3a

Please sign in to comment.