This GitHub Action runs specified target of package.json
, default is test
.
For help storing this see the GitHub docs.
Create a new Actions workflow in your selected GitHub repository. If you don't already have a workflow file,
you'll need to create a new file titled action.yml
in the .github/workflows
directory of your repository.
Under "Edit new file", paste the following code:
on: push
name: Example Workflow
jobs:
runNpmTarget:
name: Run NPM target
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Run NPM target
uses: anna-money/github-actions-npm@v2
with:
target: 'custom-target' # Remove `with` section to run default target `test`
We strongly recommend that you update the uses: anna-money/github-actions-npm@v2
to reference
the latest tag in the anna-money/github-actions-npm repository.
This will pin your workflow to a particular version of the anna-money/github-actions-npm
action.
If you already have a action.yml
file, copy and paste the above runNpmTarget
job declaration
into the jobs
section in your existing action.yml
file. If you wish to verify that you've
pasted the above correctly, you can go into the visual editor and ensure that there are no syntax errors.
As shown in the above example, the workflow should run on the push
event.
Once your workflow has been created, the best way to confirm that the workflow is executing correctly is to create a new pull request with the workflow file and verify that the newly created action succeeds.
If the action fails, there may be a problem with your configuration. To investigate, dig into the action's logs to view any error messages.