generated from dolittle/GitHub-Actions.TypeScript.Template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d985a65
commit 3357970
Showing
2 changed files
with
565 additions
and
885 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,49 @@ | ||
# GitHub Action - Release TypeScript Library | ||
|
||
This GitHub action releases a TypeScript/JavaScript library by updating its package version(s) and publishing it to npm | ||
|
||
![Github JavaScript Actions CI/CD](https://github.com/dolittle/release-typescript-lib-action/workflows/Github%20JavaScript%20Actions%20CI/CD/badge.svg) | ||
|
||
### Pre requisites | ||
|
||
Create a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow) is available below. | ||
|
||
For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file) | ||
|
||
### Inputs | ||
- `version`: The version | ||
- `root` (optional): The relative path to the root of the TypeScript project. default = root of the repository | ||
|
||
- `version`: The version | ||
- `root` (optional): The relative path to the root of the TypeScript project. default = root of the repository | ||
|
||
### Example Workflow | ||
|
||
```yaml | ||
on: | ||
push: | ||
branches: | ||
- '**' | ||
pull_request: | ||
types: [closed] | ||
push: | ||
branches: | ||
- "**" | ||
pull_request: | ||
types: [closed] | ||
|
||
name: GitHub action workflow name | ||
|
||
jobs: | ||
context: | ||
name: Job name | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v2 | ||
- name: Name here | ||
uses: dolittle/action-repository-here@tag-to-use | ||
|
||
context: | ||
name: Job name | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v2 | ||
- name: Name here | ||
uses: dolittle/action-repository-here@tag-to-use | ||
``` | ||
## Contributing | ||
We're always open for contributions and bug fixes! | ||
### Pre requisites | ||
node <= 12 | ||
yarn | ||
git |
Oops, something went wrong.