Skip to content

Commit 54e3175

Browse files
docs: update readme to better explain environment variables (#165)
1 parent 99d8c17 commit 54e3175

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,25 @@ GitLab CI cli for [changesets](https://github.com/atlassian/changesets) like its
1616

1717
### Inputs
1818

19-
> Environment valuables starts with `INPUT_`, case-sensitive, uppercase
19+
> Note: environment variables are case-sensitive
2020
21-
- PUBLISH - The command to use to build and publish packages
22-
- VERSION - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
23-
- COMMIT - The commit message to use. Default to `Version Packages`
24-
- TITLE - The merge request title. Default to `Version Packages`
21+
- `INPUT_PUBLISH` - The command to use to build and publish packages
22+
- `INPUT_VERSION` - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
23+
- `INPUT_COMMIT` - The commit message to use. Default to `Version Packages`
24+
- `INPUT_TITLE` - The merge request title. Default to `Version Packages`
2525

2626
#### Only available in `changesets-gitlab`
2727

28-
- PUBLISHED - Command executed after published
29-
- ONLY_CHANGESETS - Command executed on only changesets detected
30-
- REMOVE_SOURCE_BRANCH - Enables the merge request "Delete source branch" checkbox. Default false.
31-
- TARGET_BRANCH -> The merge request target branch. Defaults to current branch
32-
- CREATE_GITLAB_RELEASES - A boolean value to indicate whether to create Gitlab releases after publish or not. Default true.
28+
- `INPUT_PUBLISHED` - Command executed after published
29+
- `INPUT_ONLY_CHANGESETS` - Command executed on only changesets detected
30+
- `INPUT_REMOVE_SOURCE_BRANCH` - Enables the merge request "Delete source branch" checkbox. Default false.
31+
- `INPUT_TARGET_BRANCH` -> The merge request target branch. Defaults to current branch
32+
- `INPUT_CREATE_GITLAB_RELEASES` - A boolean value to indicate whether to create Gitlab releases after publish or not. Default true.
3333

3434
### Outputs
3535

36-
- published - A boolean value to indicate whether a publishing is happened or not
37-
- publishedPackages - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
36+
- `PUBLISHED` - A boolean value to indicate whether a publishing is happened or not
37+
- `PUBLISHED_PACKAGES` - A JSON array to present the published packages. The format is `[{"name": "@xx/xx", "version": "1.2.0"}, {"name": "@xx/xy", "version": "0.8.9"}]`
3838

3939
### Environment Variables
4040

0 commit comments

Comments
 (0)