Skip to content

docs: update readme to better explain environment variables #165

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

Merged
JounQin merged 2 commits into from
Feb 28, 2024
Merged

docs: update readme to better explain environment variables #165

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f66af18
update readme to better explain environment variables
meesvandongen Feb 28, 2024
e05171a
Update README.md
JounQin Feb 28, 2024
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
Next Next commit
update readme to better explain environment variables
  • Loading branch information
@meesvandongen
meesvandongen authored Feb 28, 2024
commit f66af182e91fec83f086e4471b73d2a50a656daa
25 changes: 12 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,26 +15,25 @@ GitLab CI cli for [changesets](https://github.com/atlassian/changesets) like its
## Usage

### Inputs
> Note: environment variables are case-sensitive

> Environment valuables starts with `INPUT_`, case-sensitive, uppercase

- PUBLISH - The command to use to build and publish packages
- VERSION - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
- COMMIT - The commit message to use. Default to `Version Packages`
- TITLE - The merge request title. Default to `Version Packages`
- `INPUT_PUBLISH` - The command to use to build and publish packages
- `INPUT_VERSION` - The command to update version, edit CHANGELOG, read and delete changesets. Default to `changeset version` if not provided
- `INPUT_COMMIT` - The commit message to use. Default to `Version Packages`
- `INPUT_TITLE` - The merge request title. Default to `Version Packages`

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

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

### Outputs

- published - A boolean value to indicate whether a publishing is happened or not
- 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"}]`
- `PUBLISHED` - A boolean value to indicate whether a publishing is happened or not
- `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"}]`

### Environment Variables

Expand Down