Skip to content

Commit a0ec824

Browse files
committed
docs: update README
1 parent 287efd4 commit a0ec824

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,32 @@ You can also use optional parameters `tagRegex` and `tagRegexGroup` to extract a
66

77
<a href="https://github.com/little-core-labs/get-git-tag"><img alt="GitHub Actions status" src="https://github.com/little-core-labs/get-git-tag/workflows/Tests/badge.svg"></a>
88

9+
Forked from [olegtarasov/get-tag](https://github.com/olegtarasov/get-tag) for maintenance.
10+
911
## Usage
1012

11-
Dead simple:
13+
### Pre-requisites
14+
Create a workflow `.yml` file in your repositories `.github/workflows` directory. An [example workflow](#example-workflow) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).
15+
16+
### Inputs
17+
18+
```yaml
19+
tagRegex:
20+
description: 'Regex to capture a group text as tag name. Full tag string is returned if regex is not defined.'
21+
default: ''
22+
tagRegexGroup:
23+
description: 'Regex group number to return as tag name.'
24+
default: '1'
25+
```
26+
27+
### Outputs
28+
29+
```yaml
30+
tag:
31+
description: The tag name.
32+
```
33+
34+
### Example workflow
1235
1336
```yaml
1437
steps:
@@ -23,5 +46,26 @@ Dead simple:
2346
- name: Yet another step # Environment variabl usage example
2447
run: |
2548
docker build . --file Dockerfile --tag docker.pkg.github.com/someimage:$GIT_TAG_NAME
49+
```
50+
51+
## FAQ
52+
53+
### Can you offer a major version tag/branch alias? I want automatic updates!
2654
55+
Nope! This was always weird/bad pattern of github actions and I don't have time to maintain or automate that. Luckily github offers a solution for this. Create a `.github/dependabot.yml` with, at a minimum, the following config:
56+
57+
```yaml
58+
# Basic dependabot.yml file with
59+
# minimum configuration for two package managers
60+
61+
version: 2
62+
updates:
63+
# Enable version updates for npm
64+
# Enable updates to github actions
65+
- package-ecosystem: "github-actions"
66+
directory: "/"
67+
schedule:
68+
interval: "daily"
2769
```
70+
71+
Furthermore, this action won't be changing much.

0 commit comments

Comments
 (0)