From 277fc31266386d0df0ec6c63ed0baf909edd8e29 Mon Sep 17 00:00:00 2001
From: softprops <d.tangren@gmail.com>
Date: Mon, 26 Aug 2019 00:59:00 -0400
Subject: [PATCH] docs
---
README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 45 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 80258de..41c51e7 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,46 @@
+
# action gh-release [](https://github.com/softprops/action-gh-release/actions)
A GitHub Action for creating GitHub Releases
-## Usage
+## 🤸 Usage
+
+### 🚥 Limit releases to pushes to tags
+
+Typically usage of this action involves adding a step to a build that
+is gated pushes to git tags. You may find `step.if` field helpful in accomplishing this
+as it maximizes the resuse value of your workflow for non-tag pushes.
+
+Below is a simple example of `step.if` tag gating
+
+```yaml
+name: Main
+
+on: push
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@master
+ - name: Release
+ uses: docker://softprops/action-gh-release
+ if: startsWith(github.ref, 'refs/tags/')
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+
+### ⬆️ Uploading release assets
+
+You can can configure a number of options for your
+GitHub release and all are optional.
+
+A common case for GitHub releases is to upload your binary after its been validated and packaged.
+Use the `with.files` input to declare a comma-separated list of glob expressions matching the files
+you wish to upload to GitHub releases. If you'd like you can just list the files by name directly.
```yaml
name: Main
@@ -18,6 +55,8 @@ jobs:
uses: actions/checkout@master
- name: Build
run: echo ${{ github.sha }} > Release.txt
+ - name: Test
+ run: cat Release.txt
- name: Release
uses: docker://softprops/action-gh-release
if: startsWith(github.ref, 'refs/tags/')
@@ -26,9 +65,12 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
+### 💅 Customizing
## inputs
+The following are optional as `step.with` keys
+
| Name | Type | Description |
|---------|---------|---------------------------------------------------------------|
| `body` | String | Text communicating notable changes in this release |
@@ -38,6 +80,8 @@ jobs:
## environment variables
+The following are *required* as `step.env` keys
+
| Name | Description |
|----------------|--------------------------------------|
| `GITHUB_TOKEN` | GITHUB_TOKEN as provided by `secrets`|