1+ <!-- markdownlint-disable -->
2+
13<p align =" center " >
24 <a href =" https://github.com/geoadmin/action-milestone-tag/actions " >
35 <img alt="action-milestone-tag status" src="https://github.com/geoadmin/action-milestone-tag/workflows/build-test/badge.svg">
46 </a >
57</p >
68
7- # Create a git tag based on the attached milestone
9+ # Create a Git tag based on the attached milestone
810
911- [ Description] ( #description )
1012- [ Inputs] ( #inputs )
1820
1921## Description
2022
21- This github action can be used on pull request merge to tag the repository. The
23+ This GitHub Action can be used on pull request merge to tag the repository. The
2224tag name is based on the attached milestone if any or on the previous tag.
2325
2426You can also use the input ` custom_tag ` to modify the tag name by for example
@@ -38,7 +40,7 @@ to the PR or based on the `milestone_pattern` input (default to `.*?`).
3840<!-- prettier-ignore -->
3941| Variable | Type | Default | Description |
4042| -------------------- | ------ | -------------- | ------------------------ |
41- | ` github_token ` | String | - | REQUIRED. Github token to access the repository. |
43+ | ` github_token ` | String | - | REQUIRED. GitHub token to access the repository. |
4244| ` custom_tag ` | String | ` ${MILESTONE} ` | Custom tag to set. Several placeholders can be used, see [ Custom Tag Placeholders] ( #custom-tag-placeholders ) . |
4345| ` initial_tag_number ` | Number | ` 1 ` | Initial ` TAG_NUMBER ` placeholder. |
4446| ` milestone_pattern ` | String | ` .+? ` | Milestone pattern used to search for previous tag when not milestone is attached. |
@@ -110,7 +112,7 @@ Make sure your changes follows the formatting and linting
110112npm run format-check && npm run lint
111113` ` `
112114
113- Build the typescript and package it for distribution
115+ Build the TypeScript and package it for distribution
114116
115117` ` ` bash
116118npm run build && npm run package
@@ -131,7 +133,7 @@ $ npm test
131133
132134# ## Create new Release
133135
134- Actions are run from GitHub repos so we will checkin the packed dist folder.
136+ Actions are run from GitHub repos so we will checking the packed dist folder.
135137
1361381. First make sure the version in `package.json` match the next release version,
137139 if not update it.
@@ -150,8 +152,8 @@ Actions are run from GitHub repos so we will checkin the packed dist folder.
150152
151153# ## Validate
152154
153- You can now validate the action by referencing `./` in a workflow in your repo
154- (see [test.yml](.github/workflows/test.yml))
155+ You can now validate the action by referencing `./` in a workflow in your
156+ repository (see [test.yml](.github/workflows/test.yml))
155157
156158` ` ` yaml
157159uses: ./
0 commit comments