Skip to content

Commit 72690cb

Browse files
committed
Add Readme
1 parent ff0aa13 commit 72690cb

File tree

5 files changed

+42
-0
lines changed

5 files changed

+42
-0
lines changed

.github/images/copyKeyPathDV.png

196 KB
Loading

.github/images/keyPathUsage.png

112 KB
Loading

.github/images/pawUsage.png

793 KB
Loading

.github/images/publicKeyRequest.png

268 KB
Loading

README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Paw.cloud Github Actions Secret Dynamic Value
2+
This plugin allows you to generate the LibSodium encrypted secret from within Paw.
3+
4+
![Paw Usage](./.github/images/pawUsage.png)
5+
6+
7+
## Usage
8+
When creating a request to the github API, you can add this dynamic value extenison to automatically encrypt the secret for the request per the [Github Secrets Documentation](https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#secrets). Follow the steps below to begin making calls through Paw.cloud to generate secrets for your repo.
9+
10+
1. [Get your repo's public key](https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-repository-public-key)
11+
![Public Key Request](./.github/images/publicKeyRequest.png)
12+
2. From the response of the call from step 1, get the dynamic value path for the `key`. Also make note of the dynamic value path for the `key_id`
13+
![Copy Key Path](./.github/images/copyKeyPathDV.png)
14+
3. Use the `key` and `key_id` path in the request to create a new secret.
15+
![Key Path Usage](./.github/images/keyPathUsage.png)
16+
17+
18+
## Contributing
19+
20+
### Prerequisites
21+
```shell
22+
nvm install
23+
nvm use
24+
npm install
25+
```
26+
27+
### Build
28+
```shell
29+
npm run build
30+
```
31+
32+
### Install
33+
This will install the paw extension into the default location for paw extensions.
34+
```shell
35+
make install
36+
```
37+
38+
## License
39+
40+
This Paw Extension is released under the [MIT License](LICENSE). Feel free to fork, and modify!
41+
42+
Copyright © 2020 Brian Retterer

0 commit comments

Comments
 (0)