marc/packwatch
Archived
1
0
Fork 0
Code Issues 5 Pull requests 10 Projects Releases 2 Packages Wiki Activity

Better documentation #19

Merged
mcataford merged 6 commits from best-practices-docs into master 2020-05-02 02:08:06 +00:00
Conversation 1 Commits 6 Files changed 2 +4
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit cc47c8ac6d - Show all commits

4
BEST_PRACTICES.md
View file

@ -6,6 +6,10 @@ Monitoring the footprint of the packages you publish can be a powerful first ste
Got best practices questions or suggestions? Open an [issue](https://github.com/mcataford/packwatch/issues)!
### First-run
On the first-run, Packwatch will generate a manifest file that sets the package size and the limit to the same value. Following this, the run will return a non-zero status code. This is perfectly normal! This is meant to ensure that an initial run or a run without a manifest won't pass on CI. The next time you will run Packwatch, it will use the now-present manifest as a comparison point and proceed normally.
### Understanding `.packwatch.json`
The `.packwatch.json` file persisted in your project keeps track of the last reported package size that was commited to your version control system. At the moment, it consists of three keys: