Merge pull request #12 from technote-space/release/v1.0.0

release/v1.0.0

Author: technote-space

.github/workflows/ci.yml

@@ -27,6 +27,8 @@ jobs:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
           COVERALLS_SERVICE_NAME: "GitHub Action"
           COVERALLS_SERVICE_JOB_ID: ${{ github.sha }}
+          COVERALLS_GIT_COMMIT: ${{ github.sha }}
+          COVERALLS_GIT_BRANCH: ${{ github.ref }}
         if: github.event_name == 'pull_request' || github.ref == 'refs/heads/master'
       - uses: 8398a7/action-slack@v1
         with:

.github/workflows/released.yml

@@ -1,12 +1,12 @@
 on: release
-name: Released
+name: Release
 jobs:
   release:
     name: Release GitHub Actions
     runs-on: ubuntu-latest
     steps:
       - name: Release GitHub Actions
-        uses: technote-space/release-github-actions@pre
+        uses: technote-space/release-github-actions@test
         with:
           ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
           COMMIT_NAME: Technote

README.md

@@ -5,8 +5,61 @@
 [![CodeFactor](https://www.codefactor.io/repository/github/technote-space/release-github-actions/badge)](https://www.codefactor.io/repository/github/technote-space/release-github-actions)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/technote-space/release-github-actions/blob/master/LICENSE)
 
-GitHub actions to auto release.
-
-## Screenshot
+GitHub actions to auto release.  
+Once you publish the release, this action will run build and create branch automatically.
 
 ## Installation
+.github/workflows/release.yml
+```yaml
+on: release
+name: Release
+jobs:
+  release:
+    name: Release GitHub Actions
+    runs-on: ubuntu-latest
+    steps:
+      - name: Release GitHub Actions
+        uses: technote-space/[email protected]
+        with:
+          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+```
+
+## ACCESS_TOKEN
+1. Generate a [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) with the public_repo or repo scope.
+(repo is required for private repositories).  
+1. [Save as secrets](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables)
+
+## Details
+### Target event
+- release
+### Target action
+- published
+### Branch name
+- Tag name
+
+## Options
+### BUILD_COMMAND
+Build command.  
+default: `''`  
+- If package.json includes build or production or prod in scripts, the command is used for build.  
+- If command does not have install command like `npm run install` or `yarn install`, install commands are added.  
+
+so if `BUILD_COMMAND` is not provided and package.json has `build` script,
+the following commands are executed.
+```shell
+yarn install
+yarn build
+yarn install --production
+```
+
+### COMMIT_MESSAGE
+Commit message.  
+default: `'feat: Build for release'`
+
+### COMMIT_NAME
+Commit name.  
+default: `'GitHub Actions'`
+
+### COMMIT_EMAIL
+Commit email.  
+default: `'[email protected]'`