Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hiqqs authored Apr 30, 2021
1 parent 75b86d4 commit 1157560
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
📦 [Install](#install)\
     :electron: [npm](#npm)\
     🧶 [yarn](#yarn)\
ℹ️ [Info](#info)\
ℹ️ [Background](#background)\
🚉 [CI Examples](#ci-examples)\
     🔵 [Bitbucket Pipelines](#bitbucket-pipelines)\
     🟢 [CircleCi](#circleci)\
Expand All @@ -22,7 +22,9 @@
#### yarn
`yarn add releasetrain`

### Info
### Background
Do you want to automate release candidates rather than manually cutting them everytime? Perhaps just have an optional job in a CI pipeline you can just run to create a new release candidate? Simply add release train with the `ci-examples` for yaml configurations. It cuts a new branch with `RC-` (release candidate) prefix followed by the desired release version and sets upstream / pushes to origin. It then sends out a slack notification to specified channel with information you can pass in a pipeline / action.

These are they variables that releaseTrain uses and example how you could set them locally if desired in a shorthand script

* appName: your app name (gets included in slack alert)
Expand Down

0 comments on commit 1157560

Please sign in to comment.