Skip to content

Commit

Permalink
Merge pull request #71 from apomalyn/feature/yaml-handler
Browse files Browse the repository at this point in the history
Yaml handler
  • Loading branch information
apomalyn authored Jul 26, 2022
2 parents 68a638a + 3a9e3c0 commit 16c4db5
Show file tree
Hide file tree
Showing 20 changed files with 1,851 additions and 1,639 deletions.
1 change: 1 addition & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
* @actions/actions-runtime
* apomalyn
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ Let's do an example:
4. We synchronize the PR#1 with the main branch
- The action start and update the version to 1.1.1

## Supported type of files

Here is the list of files the action is supporting. If you don't find yours please fill an issue!

- Yaml (.yaml, .yml)
- Json (.json)

## Example workflow

Here is a minimal example:
Expand Down Expand Up @@ -61,8 +68,8 @@ This will update the `package.json` file and comment the PR after each update.
## Inputs

| Parameter | Description | required | default |
|:-------------------:|-------------------------------------------------------------------------------------------------------------------------------------|:--------:|:----------------------------------------------:|
| `file_path` | Path to the file that contains the version. The file should be a YAML or a JSON file | ✅ | |
|:-------------------:|----------------------------------------------------------------------------------------------------------------------------------|:--------:|:----------------------------------------------:|
| `file_path` | Path to the file that contains the version. | ✅ | |
| `patch_label` | Label used to update the minor version (x.x.PATCH) | ❌ | `version: Patch` |
| `minor_label` | Label used to update the minor version (x.MINOR.0) | ❌ | `version: Minor` |
| `major_label` | Label used to update the minor version (MAJOR.0.0) | ❌ | `version: Major` |
Expand All @@ -75,7 +82,6 @@ This will update the `package.json` file and comment the PR after each update.
| `commit_message` | Message used for the commit. You can use '{old}' and '{new}' to display the ancient and new version. Ignored if `commit` is false. | ❌ | `[BOT] Bump version from {old} to {new}` |
| `commit_user_name` | Name used for the commit user. Ignored if `commit` is false. | ❌ | `github-actions[bot]` |
| `commit_user_email` | Email address used for the commit user. Ignored if `commit` is false. | ❌ | `github-actions[bot]@users.noreply.github.com` |
| `json_spacing` | Set the spacing-level of the JSON. Only used if the file to update is a json. | ❌ | 2 |

## Outputs

Expand Down
1,485 changes: 473 additions & 1,012 deletions dist/index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

Loading

0 comments on commit 16c4db5

Please sign in to comment.