diff --git a/README.md b/README.md index 437d1f1..afd7a87 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ # Semantic Release Action -GitHub Action for [Semantic Release](https://github.com/semantic-release/semantic-release). +[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) + +GitHub Action for [Semantic Release](https://github.com/semantic-release/semantic-release). ## Usage +#### Step1: Set any [Semantic Release Configuration](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration) in your repository. + +#### Step2: [Add Secrets](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) in your repository for the [Semantic Release Authentication](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/ci-configuration.md#authentication) Environment Variables. + +#### Step3: Add a [Workflow File](https://help.github.com/en/articles/workflow-syntax-for-github-actions) to your repository to create custom automated processes. * inputs: * `branch`: [Optional] The branch for release. Default `"master"`. * `extra_plugins`: [Optional] Extra plugins for pre-install. Default `""`. @@ -12,7 +19,7 @@ A simple example ```yaml steps: - name: Semantic Release - uses: cycjimmy/semantic-release-action@master + uses: cycjimmy/semantic-release-action@v1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }} @@ -22,8 +29,8 @@ An advanced example ```yaml steps: - name: Semantic Release - uses: cycjimmy/semantic-release-action@master - id: semantic + uses: cycjimmy/semantic-release-action@v1 + id: semantic # Need an `id` for output variables with: branch: master extra_plugins: |