Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Klemensas committed Mar 8, 2020
1 parent 2ac4021 commit f38f3e2
Showing 1 changed file with 9 additions and 21 deletions.
30 changes: 9 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: butlerlogic/action-autotag@stable
- uses: Klemensas/action-autotag@stable
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
```
Expand All @@ -37,7 +37,7 @@ This **order** is important!
```yaml
- uses: actions/checkout@v2
- uses: butlerlogic/action-autotag@stable
- uses: Klemensas/action-autotag@stable
```
> If the repository is not checked out first, the autotagger cannot find the package.json file.
Expand All @@ -47,7 +47,7 @@ This **order** is important!
The `GITHUB_TOKEN` must be passed in. Without this, it is not possible to create a new tag. Make sure the autotag action looks like the following example:

```yaml
- uses: butlerlogic/action-autotag@stable
- uses: Klemensas/action-autotag@stable
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
```
Expand All @@ -63,7 +63,7 @@ There are several options to customize how the tag is created.
By default, autotag will look for the `package.json` file in the project root. If the file is located in a subdirectory, this option can be used to point to the correct file.

```yaml
- uses: butlerlogic/action-autotag@1.0.0
- uses: Klemensas/action-autotag@stable
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
package_root: "/path/to/subdirectory"
Expand All @@ -74,7 +74,7 @@ There are several options to customize how the tag is created.
By default, `package.json` uses [semantic versioning](https://semver.org/), such as `1.0.0`. A prefix can be used to add text before the tag name. For example, if `tag_prefix` is set to `v`, then the tag would be labeled as `v1.0.0`.

```yaml
- uses: butlerlogic/action-autotag@1.0.0
- uses: Klemensas/action-autotag@stable
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
tag_prefix: "v"
Expand All @@ -85,7 +85,7 @@ There are several options to customize how the tag is created.
Text can also be applied to the end of the tag by setting `tag_suffix`. For example, if `tag_suffix` is ` (beta)`, the tag would be `1.0.0 (beta)`. Please note this example violates semantic versioning and is merely here to illustrate how to add text to the end of a tag name if you _really_ want to.

```yaml
- uses: butlerlogic/action-autotag@1.0.0
- uses: Klemensas/action-autotag@stable
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
tag_suffix: " (beta)"
Expand All @@ -97,7 +97,7 @@ There are several options to customize how the tag is created.
changelog will be generated from the commits between the latest tag and the new tag (HEAD). Setting this option will override it witha custom message.

```yaml
- uses: butlerlogic/action-autotag@1.0.0
- uses: Klemensas/action-autotag@stable
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
tag_message: "Custom message goes here."
Expand All @@ -109,7 +109,7 @@ There are several options to customize how the tag is created.
Useful for non-JavaScript projects where version may be output by a previous action.

```yaml
- uses: butlerlogic/action-autotag@1.0.0
- uses: Klemensas/action-autotag@stable
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
version: "${{ steps.previous_step.outputs.version }}"
Expand All @@ -129,16 +129,4 @@ If you are building an action that runs after this one, be aware this action pro

## Credits

This action was written and is primarily maintained by [Corey Butler](https://github.com/coreybutler).

# Our Ask...

If you use this or find value in it, please consider contributing in one or more of the following ways:

1. Click the "Sponsor" button at the top of the page.
1. Star it!
1. [Tweet about it!](https://twitter.com/intent/tweet?hashtags=github,actions&original_referer=http%3A%2F%2F127.0.0.1%3A91%2F&text=I%20am%20automating%20my%20workflow%20with%20the%20Autotagger%20Github%20action!&tw_p=tweetbutton&url=https%3A%2F%2Fgithub.com%2Fmarketplace%2Factions%2Fautotagger&via=goldglovecb)
1. Fix an issue.
1. Add a feature (post a proposal in an issue first!).

Copyright © 2019 ButlerLogic, Corey Butler, and Contributors.
This action was originally created by [Corey Butler](https://github.com/coreybutler).

0 comments on commit f38f3e2

Please sign in to comment.