Skip to content

Commit 6c067d6

Browse files
committed
Document can-push input parameter
1 parent c04569f commit 6c067d6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![codecov](https://codecov.io/gh/widoz/github-artifacts-action/graph/badge.svg?token=TF80AM1DUZ)](https://codecov.io/gh/widoz/github-artifacts-action)
77
![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/widoz/github-artifacts-action?utm_source=oss&utm_medium=github&utm_campaign=widoz%2Fgithub-artifacts-action&labelColor=171717&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)
88

9-
Assets Artifacts, is designed to compile the assets of your project and commit and push these assets back into the repository. It also moves the tags to point to the commit where the assets are pushed.
9+
Assets Artifacts is designed to compile the assets of your project and commit and push these assets back into the repository. It also moves the tags to point to the commit where the assets are pushed.
1010

1111
## What it does
1212

@@ -20,6 +20,7 @@ Assets Artifacts, is designed to compile the assets of your project and commit a
2020

2121
- `command` Pass the command the action has to use to build the artifacts. Default to `yarn build`.
2222
- `target-dir` Pass the director where the action has to store the artifacts. Default to `build`.
23+
- `can-push` Pass the boolean indicating if the assets can be pushed or not. Default to `true`.
2324

2425
## Workflow Example
2526

@@ -66,6 +67,7 @@ jobs:
6667
with:
6768
command: 'npm run build'
6869
target-dir: './dist'
70+
can-pus: 'false'
6971
```
7072
7173
In this workflow, the action is triggered on every push event that includes a tag. The workflow runs on the latest version of Ubuntu and will not run if the commit message contains `--skip-assets-artifacts`.

0 commit comments

Comments
 (0)