Skip to content

Commit

Permalink
Remove from README
Browse files Browse the repository at this point in the history
  • Loading branch information
JasonEtco committed Mar 1, 2021
1 parent c425d18 commit 366b6f9
Showing 1 changed file with 2 additions and 15 deletions.
17 changes: 2 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

A GitHub Action for publishing JavaScript Actions! It's designed to act on new releases, and updates the tag with a compiled JS file, using [`@vercel/ncc`](https://github.com/vercel/ncc). The process looks like this:

- Runs the `setup` input (default: `npm ci && npm run build`)
- Reads the `main` property in your `package.json`
- Force pushes `action.yml` and the above file to the release's tag
- Force pushes to the major version tag (ex: `v1.0.0` -> `v1`)
Expand All @@ -33,6 +32,8 @@ jobs:
uses: actions/checkout@v2
with:
ref: ${{ github.event.release.tag_name }}
- name: Install deps and build
run: npm ci && npm run build
- uses: JasonEtco/build-and-tag-action@v1
env:
GITHUB_TOKEN: ${{ github.token }}
Expand All @@ -58,20 +59,6 @@ Your `package.json` will probably contain a `dependencies` section, in addition

## Options

**setup**

You can customize the `setup` script that's run before pushing the files to the tag.

```yaml
- uses: JasonEtco/build-and-tag-action@v1
with:
setup: 'npm ci && npm run super-build'
env:
GITHUB_TOKEN: ${{ github.token }}
```

The default is `npm ci && npm run build --if-present`. You can disable it entirely by setting `setup: ''`!

**tag_name**

The tag to update. If the workflow event is `release`, it will use the `tag_name` from the event payload. This option can be useful when using this action in a workflow with other actions that generate a release:
Expand Down

0 comments on commit 366b6f9

Please sign in to comment.