Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2eab60dfff084efbabaf37708fba4d66)](https://app.codacy.com/gh/tj-actions/sync-release-version?utm_source=github.com\&utm_medium=referral\&utm_content=tj-actions/sync-release-version\&utm_campaign=Badge_Grade_Settings)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/55332b43f1ba4db9a3648bcbffae800a)](https://app.codacy.com/gh/tj-actions/sync-release-version/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

Check warning

Code scanning / Markdownlint (reported by Codacy)

First line in a file should be a top-level heading Warning

First line in a file should be a top-level heading
[![CI](https://github.com/tj-actions/sync-release-version/workflows/CI/badge.svg)](https://github.com/tj-actions/sync-release-version/actions?query=workflow%3ACI)
[![Update release version.](https://github.com/tj-actions/sync-release-version/workflows/Update%20release%20version./badge.svg)](https://github.com/tj-actions/sync-release-version/actions?query=workflow%3A%22Update+release+version.%22)
[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fused-by.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Dtj-actions%2Fsync-release-version%26badge%3Dtrue)](https://github.com/search?o=desc\&q=tj-actions+sync-release-version+path%3A.github%2Fworkflows+language%3AYAML\&s=\&type=Code)

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

## sync-release-version
Expand Down Expand Up @@ -120,20 +122,21 @@
fetch-depth: 0
- name: Sync release version.
uses: tj-actions/sync-release-version@v7
```

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 270 Warning

Expected: 80; Actual: 270

## Inputs

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 271 Warning

Expected: 80; Actual: 271

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: a Warning

Element: a

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 271 Warning

Expected: 80; Actual: 271

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: a Warning

Element: a
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 271 Warning

Expected: 80; Actual: 271

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br Warning

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: a Warning

Element: a

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: a Warning

Element: a

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br Warning

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 270 Warning

Expected: 80; Actual: 270
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-------------------------------------------------------------------------------|--------|----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|
| <a name="input_current_version"></a>[current\_version](#input_current_version) | string | false | | The current project version (Default: The last git tag). |
| <a name="input_new_version"></a>[new\_version](#input_new_version) | string | false | | The next project version (Default: The new git tag). |
| <a name="input_only_major"></a>[only\_major](#input_only_major) | string | false | `"false"` | Only update the major version <br>number. |
| <a name="input_paths"></a>[paths](#input_paths) | string | true | | A list of file names <br>to search and replace versions. |
| <a name="input_pattern"></a>[pattern](#input_pattern) | string | false | | The pattern to match the <br>location that needs to be <br>updated. |
| <a name="input_strip_prefix"></a>[strip\_prefix](#input_strip_prefix) | string | false | | Prefix to strip from the <br>tag. For example if `strip_prefix` <br>is set to `v` and <br>the tag is `v1.0.0` the <br>output becomes `1.0.0`. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 270 Warning

Expected: 80; Actual: 270

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: a Warning

Element: a

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br Warning

Element: br
|-------------------------------------------------------------------------------------------|--------|----------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: a Warning

Element: a

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br Warning

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 271 Warning

Expected: 80; Actual: 271
| <a name="input_current_version"></a>[current\_version](#input_current_version) | string | false | | The current project version (Default: The last git tag). |
| <a name="input_new_version"></a>[new\_version](#input_new_version) | string | false | | The next project version (Default: The new git tag). |
| <a name="input_only_major"></a>[only\_major](#input_only_major) | string | false | `"false"` | Only update the major version <br>number. |
| <a name="input_paths"></a>[paths](#input_paths) | string | true | | A list of file names <br>to search and replace versions. |
| <a name="input_pattern"></a>[pattern](#input_pattern) | string | false | | The pattern to match the <br>location that needs to be <br>updated. |
| <a name="input_strip_prefix"></a>[strip\_prefix](#input_strip_prefix) | string | false | | Prefix to strip from the <br>tag. For example if `strip_prefix` <br>is set to `v` and <br>the tag is `v1.0.0` the <br>output becomes `1.0.0`. |
| <a name="input_use_tag_commit_hash"></a>[use\_tag\_commit\_hash](#input_use_tag_commit_hash) | string | false | `"false"` | When true, uses commit hash <br>in the replacement pattern. For <br>example, replaces `hash # v1` with `hash # v2`. |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br Warning

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: a Warning

Element: a

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 273 Warning

Expected: 80; Actual: 273

<!-- AUTO-DOC-INPUT:END -->

Expand Down Expand Up @@ -189,8 +192,11 @@
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<!-- prettier-ignore-start -->

<!-- markdownlint-disable -->

<table>
<tbody>
<tr>
Expand All @@ -200,6 +206,7 @@
</table>

<!-- markdownlint-restore -->

<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
Expand Down
Loading