Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md #191

Merged
merged 1 commit into from
Dec 16, 2022
Merged

Updated README.md #191

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,26 +122,26 @@ Creating a new release `v6.8 -> v7` using the recommended configuration above.

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

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-----------------|--------|----------|-----------|-------------------------------------------------------------------|
| current\_version | string | false | | The current project version (Defualt:<br>The last git tag). |
| new\_version | string | false | | The next project version (Default:<br>The new git tag). |
| only\_major | string | false | `"false"` | Only update the major version<br>number. |
| paths | string | true | | A list of file names<br>to search and replace versions.<br> |
| pattern | string | false | | The pattern to match the<br>location that needs to be<br>updated. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-----------------|--------|----------|-----------|----------------------------------------------------------------|
| current\_version | string | false | | The current project version (Defualt: The last<br>git tag). |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 117

Expected: 80; Actual: 117
| new\_version | string | false | | The next project version (Default: The new<br>git tag). |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 117

Expected: 80; Actual: 117
| only\_major | string | false | `"false"` | Only update the major version number. |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 117

Expected: 80; Actual: 117
| paths | string | true | | A list of file names to search<br>and replace versions. |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br

Element: br

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 116

Expected: 80; Actual: 116
| pattern | string | false | | The pattern to match the location that<br>needs to be updated. |

Check warning

Code scanning / Markdownlint (reported by Codacy)

Expected: 80; Actual: 116

Expected: 80; Actual: 116

Check warning

Code scanning / Markdownlint (reported by Codacy)

Element: br

Element: br

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

## Outputs

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

| OUTPUT | TYPE | DESCRIPTION |
|--------------------|--------|--------------------------------------------|
| is\_initial\_release | string | Boolean indicating an initial release.<br> |
| major\_update | string | Boolean indicating a major version<br>bump |
| new\_version | string | The current project version |
| old\_version | string | The previous project version |
| OUTPUT | TYPE | DESCRIPTION |
|--------------------|--------|-----------------------------------------|
| is\_initial\_release | string | Boolean indicating an initial release. |
| major\_update | string | Boolean indicating a major version bump |
| new\_version | string | The current project version |
| old\_version | string | The previous project version |

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

Expand Down