Skip to content

Commit

Permalink
docs(mojaloop/#3455): update readme (#76)
Browse files Browse the repository at this point in the history
docs(mojaloop/#3455): update readme
- updated audit section of the readme
- removed sonarqube from ci cofnig
- updated dependencies
  • Loading branch information
oderayi authored Aug 29, 2023
1 parent 16b5faf commit 65d4257
Show file tree
Hide file tree
Showing 4 changed files with 517 additions and 986 deletions.
10 changes: 0 additions & 10 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -237,16 +237,6 @@ jobs:
destination: test
- store_test_results:
path: coverage
- run:
name: Copy code coverage to SonarQube
command: |
if [ "${CIRCLE_BRANCH}" == "master" ];
then
echo "Sending lcov.info to SonarQube..."
aws s3 cp coverage/lcov.info $AWS_S3_DIR_SONARQUBE/${CIRCLE_PROJECT_REPONAME}/lcov.info
else
echo "Not a release (env CIRCLE_BRANCH != 'master'), skipping sending lcov.info to SonarQube."
fi

vulnerability-check:
executor: default-docker
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@ Examples of usage of the SDK can be found in the `src/examples` directory of thi

## Auditing Dependencies

We use `npm-audit-resolver` along with `npm audit` to check dependencies for vulnerabilities, and keep track of resolved dependencies with an `audit-resolv.json` file.
We use `audit-ci` along with `npm audit` to check dependencies for node vulnerabilities, and keep track of resolved dependencies with an `audit-ci.jsonc` file.

To start a new resolution process, run:

```bash
npm run audit:resolve
npm run audit:fix
```

You can then check to see if the CI will pass based on the current dependencies with:
Expand All @@ -98,7 +98,7 @@ You can then check to see if the CI will pass based on the current dependencies
npm run audit:check
```

And commit the changed `audit-resolv.json` to ensure that CircleCI will build correctly.
The [audit-ci.jsonc](./audit-ci.jsonc) contains any audit-exceptions that cannot be fixed to ensure that CircleCI will build correctly.

## Automated Releases

Expand Down
Loading

0 comments on commit 65d4257

Please sign in to comment.