Skip to content

Commit 62584b8

Browse files
committed
fix: add github actions docs to README
1 parent c8c9dd7 commit 62584b8

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,22 @@ Check out the site at [https://packagemap.co](https://packagemap.co)
88

99
Code 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

1328
1. Sign up at [packagemap.co](http://packagemap.co) to get an API Access key, and API Secret key.
1429
2. Download the jar from the release page and run it

action.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,11 @@ outputs:
1818
description: 'link to the packagemap ui'
1919
runs:
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

0 commit comments

Comments
 (0)