Skip to content

Commit

Permalink
doc(publish): revamp documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hdorgeval committed Nov 30, 2018
1 parent 3fe5112 commit c8c1c65
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Expand Up @@ -22,10 +22,32 @@ This example shows up that you are about to push your test files to the registry

![dry-run-demo-with-errors](media/dry-run-with-errors.gif)

when all validations pass, publish-please will show you the exact content of the package that will be sent to the registry, so you can check everything is included in the package:
When all validations pass, publish-please will show you the exact content of the package that will be sent to the registry, so you can check everything is included in the package:

![dry-run-demo-success](media/dry-run-demo-success.gif)

### **The validation workflow performs by default the following actions:**
- **npm test**
- Check that all tests pass

- **Checking for the vulnerable dependencies**
- Perform vulnerable dependencies check using `npm audit`

- **Checking for the uncommitted changes**
- Check that there are no uncommitted changes in the working tree

- **Checking for the untracked files**
- Check that there are no untracked files in the working tree

- **Checking for the sensitive and non-essential data in the npm package**
- Check that the npm package will not embed sensitive files or useless files (like test files)

- **Validating branch**
- Check that current branch is master

- **Validating git tag**
- Check that git tag matches version specified in the `package.json`



[to be continued]

0 comments on commit c8c1c65

Please sign in to comment.