File tree Expand file tree Collapse file tree 2 files changed +20
-4
lines changed
Expand file tree Collapse file tree 2 files changed +20
-4
lines changed Original file line number Diff line number Diff line change @@ -8,7 +8,22 @@ Check out the site at [https://packagemap.co](https://packagemap.co)
88
99Code review just got a lot easier! Visualise your code.
1010
11- ## Getting started
11+ ## Getting started - github action
12+
13+ Use the github action:
14+ ``` yaml
15+ - name : PackageMap java parser Github action
16+ uses : packagemap/packagemap-java-parser@v0.0.2
17+ with :
18+ src_dir : ' src/main/java'
19+ base : ' com.mycompany'
20+ api_key : ${{ secrets.PACKAGEMAP_KEY }}
21+ ` ` `
22+
23+ 1. Add the github action config
24+ 2. Add a PACKAGEMAP_KEY secret to your repo in the format ` user_id:secret_key`
25+
26+ # # Getting started - local
1227
13281. Sign up at [packagemap.co](http://packagemap.co) to get an API Access key, and API Secret key.
14292. Download the jar from the release page and run it
Original file line number Diff line number Diff line change @@ -18,10 +18,11 @@ outputs:
1818 description : ' link to the packagemap ui'
1919runs :
2020 using : ' docker'
21- image : ' packagemap/packagemap-java-parser:0.0.2'
21+ image : ' docker:// packagemap/packagemap-java-parser:0.0.2'
2222 env :
23- - PACKAGEMAP_KEY= ${{ inputs.api_key }}
23+ PACKAGEMAP_KEY : ${{ inputs.api_key }}
2424 args :
25- - --base ${{ inputs.base }}
25+ - --base
26+ - ${{ inputs.base }}
2627 - ${{ inputs.src_dir }}
2728
You can’t perform that action at this time.
0 commit comments