Skip to content

Commit

Permalink
Update readmes.
Browse files Browse the repository at this point in the history
  • Loading branch information
elstudio authored Feb 26, 2021
1 parent a639737 commit 65bf468
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 11 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Perfect for Grunt or Gulp tasks that do CSS (or SASS/LESS) compilation or JS tra

This repository contains two actions that may be used independently -- typically one after another:

- **build** (elstudio/actions-js-build/build@v2): Looks for a gulpfile.js or Gruntfile.js in the working directory, then installs any required npm packages and runs the appropriate build tool. If it finds neither gulp or grunt, the script runs npm. Set the workflow `args` arguments to run the tasks of your choice.
- **commit** (elstudio/actions-js-build/commit@v3): Commits any file changes, and pushes them back to the current branch of the origin repository on GitHub.
- **build** (elstudio/actions-js-build/build@v4): Looks for a gulpfile.js or Gruntfile.js in the working directory, then installs any required npm packages and runs the appropriate build tool. If it finds neither gulp or grunt, the script runs npm. Set the workflow `args` arguments to run the tasks of your choice.
- **commit** (elstudio/actions-js-build/commit@v4): Commits any file changes, and pushes them back to the current branch of the origin repository on GitHub.


## Usage
Expand All @@ -26,14 +26,17 @@ jobs:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 12

- name: Compile with Grunt
uses: elstudio/actions-js-build/build@v4-beta
uses: elstudio/actions-js-build/build@v4
with:
wdPath: './web/themes/nw8'

- name: Commit changes
uses: elstudio/actions-js-build/commit@v4-beta
uses: elstudio/actions-js-build/commit@v4
with:
commitMessage: Regenerate css
```
Expand Down
10 changes: 6 additions & 4 deletions build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Run JS build tasks with Gulp, Grunt or NPM.

Perfect for Grunt tasks that do CSS (or SASS/LESS) compilation or JavaScript transpilation.

- **build** (elstudio/actions-js-build/build@master): Looks for a gulpfile.js or Gruntfile.js in the working directory, then installs any required npm packages and runs the build tool. If it finds neither gulp or grunt, the script runs npm. Set the workflow `args` arguments to run the tasks of your choice.
- **build** (elstudio/actions-js-build/build@v4): Looks for a gulpfile.js or Gruntfile.js in the working directory, then installs any required npm packages and runs the build tool. If it finds neither gulp or grunt, the script runs npm. Set the workflow `args` arguments to run the tasks of your choice.

This Action for [npm](https://www.npmjs.com/) installs any required npm packages, then installs and runs any installed JavaScript build tools -- currently either Gulp or Grunt.

Expand All @@ -25,14 +25,16 @@ jobs:

steps:
- uses: actions/checkout@v2

- uses: actions/setup-node@v2
with:
node-version: 12
- name: Compile with Grunt
uses: elstudio/actions-js-build/build@v4-beta
uses: elstudio/actions-js-build/build@v4
with:
wdPath: './web/themes/nw8'

- name: Commit changes
uses: elstudio/actions-js-build/commit@v4-beta
uses: elstudio/actions-js-build/commit@v4
with:
commitMessage: Regenerate css
```
Expand Down
9 changes: 6 additions & 3 deletions commit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This Action for git commits any changed files and pushes those changes back to the origin repository.

**V3 or later of this action (elstudio/actions-js-build/commit@v3) requires actions/checkout@v2 or later.**
**V3 or later of this action (elstudio/actions-js-build/commit@v4) requires actions/checkout@v2 or later.**

## Usage

Expand All @@ -21,14 +21,17 @@ jobs:

steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 12

- name: Compile with Grunt
uses: elstudio/actions-js-build/build@4-beta
uses: elstudio/actions-js-build/build@4
with:
wdPath: './web/themes/nw8'

- name: Commit changes
uses: elstudio/actions-js-build/commit@v4-beta
uses: elstudio/actions-js-build/commit@v4
with:
commitMessage: Regenerate css
```
Expand Down

0 comments on commit 65bf468

Please sign in to comment.