Skip to content

Commit 28ed6df

Browse files
authored
Update README.md
Clarify that I use `git describe --tags` to query tags.
1 parent a1b72cb commit 28ed6df

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# query-tag-action
22

3-
A GitHub Action allowing users to query tags via `git describe`.
3+
A GitHub Action allowing users to query tags via `git describe --tags`.
44

55
This is useful, for example, if you want to generate a changelog from your last release tag to your newest. Rather than apply that logic to multiple changelog tools, this action will set an output parameter to the last found tag. You should then be able to use that parameter in any changelog utility you'd like.
66

7-
This action acts as a wrapper around [`git describe`](https://git-scm.com/docs/git-describe), performing an `unshallow` operation on the git repository by default.
7+
This action acts as a wrapper around [`git describe --tags`](https://git-scm.com/docs/git-describe), performing an `unshallow` operation on the git repository by default.
88

99
The `actions/checkout@v2` action will check out a shallow repository. Although that action's [readme](https://github.com/actions/checkout) documents how to unshallow, many users will never read that readme. For those savvy users who are already performing an unshallow, you may skip that operation in this action by passing the input `skip-unshallow: "true"`.
1010

0 commit comments

Comments
 (0)