Skip to content

Commit

Permalink
Add more info to readme on how to use published resources
Browse files Browse the repository at this point in the history
  • Loading branch information
snf2ye committed Aug 2, 2023
1 parent 0d7456e commit 96d1b03
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,19 @@

A java implementation of the [pyPFB](https://github.com/uc-cdis/pypfb) library that includes a CLI and a java library.


## Getting Started
See the [library README](library/README.md) for more details on how to reference the lbirary in your project.

The CLI is a wrapper around the library. See the [CLI README](cli/README.md) for more information.

## Developer Information

## Publishing
See [library](library/README.md) and [cli](cli/README.md) readmes for more details.
### Publishing

See [library](library/README.md) and [cli](cli/README.md) readmes for more details.

## Running SourceClear locally
### Running SourceClear locally

[SourceClear](https://srcclr.github.io) is a static analysis tool that scans a project's Java
dependencies for known vulnerabilities. If you get a build failure due a SourceClear error and want
Expand All @@ -23,7 +28,7 @@ export SRCCLR_API_TOKEN=$(vault read -field=api_token secret/secops/ci/srcclr/gr

Results of the scan are uploaded to [Veracode](https://sca.analysiscenter.veracode.com/workspaces/jppForw/projects/768265/issues). You can request an account to view results from #dsp-infosec-champions.

## Running SonarQube locally
### Running SonarQube locally

[SonarQube](https://www.sonarqube.org) is a static analysis code that scans code for a wide
range of issues, including maintainability and possible bugs. If you get a build failure due to
Expand Down
6 changes: 6 additions & 0 deletions library/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
Java PFB Library
===
## Referencing the Library
The library is published to a central Maven repository. To use the library, add the following to your build.gradle:
```groovy
implementation "bio.terra:java-pfb-library:<Tagged Version>"
```
You can find the latest tagged version on [Github](https://github.com/DataBiosphere/java-pfb/tags).

## Publishing the Library
JFrog Artifactory is used to publish libraries to a central Maven repository. The library version number is the version in settings.gradle. We use github actions to bump the version and publish to Artifactory.
Expand Down

0 comments on commit 96d1b03

Please sign in to comment.