maverick/flex-template-web
1
0
Fork 0
mirror of https://github.com/kingomarnajjar/flex-template-web.git synced 2026-07-26 06:47:17 +10:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add CI docs

Browse source
This commit is contained in:
Kimmo Puputti 2017-10-13 11:42:16 +03:00
parent df5d10eaa0
commit 343d2e63d7
2 changed files with 42 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/README.md
View file

@ -1,9 +1,15 @@
# Sharetribe Starter App Documentation
The application was bootstrapped with a forked version of [create-react-app](https://github.com/facebookincubator/create-react-app). While most of the original documentation still apply, there are some important differences listed in the [sharetribe-scripts](https://www.npmjs.com/package/sharetribe-scripts) NPM package.
The application was bootstrapped with a forked version of
[create-react-app](https://github.com/facebookincubator/create-react-app). While
most of the original documentation still apply, there are some
important differences listed in the
[sharetribe-scripts](https://www.npmjs.com/package/sharetribe-scripts)
NPM package.
Documentation for specific topics can be found in the following files:
- Original [create-react-app documentation](create-react-app.md)
- [Testing](testing.md)
- [Error logging with Sentry](sentry.md)
- [CI](ci.md)

35
docs/ci.md Normal file
View file

@ -0,0 +1,35 @@
# CI
The application provides a configuration to use
[CircleCI](https://circleci.com/) as a continuous integration server
to run tests and other scripts. This ensures quality and can be forced
to avoid merging changes that break tests or fail audits.
The [circle.yml](../circle.yml) file is used to configure CircleCI.
Currently the CI runs the following scripts:
## Security audit: `yarn run audit`
This command runs the security audit using
[nsp](https://www.npmjs.com/package/nsp). The audit checks for
installed packages with known vulnerabilities and warns about those.
The scripts outputs information about the dependency path that added
the package. If that information is not enough, `yarn why
package-name` can be used to get more detailed information about why
the package is installed.
## Code formatting: `yarn run format-ci`
This command fails if there are changes in the formatting that are not
committed. Run `yarn run format` to format the code and get rid of the
error.
## Build: `yarn run build`
This command ensures that the build passes.
## Tests: `yarn run test-ci`
This command runs the tests.