dorky 1.0.6 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +27 -0
- package/README.md +23 -3
- package/dorky-usage.svg +1 -0
- package/index.js +32 -19
- package/package.json +1 -1
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
name: "🚀 Publish on npm"
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
release:
|
|
10
|
+
name: 🚀 release
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
strategy:
|
|
13
|
+
matrix:
|
|
14
|
+
node: [ "8", "10", "12", "14", "16", "18", "20" ]
|
|
15
|
+
steps:
|
|
16
|
+
- name: Checkout
|
|
17
|
+
uses: actions/checkout@v4
|
|
18
|
+
- name: Setup node
|
|
19
|
+
uses: actions/setup-node@v3
|
|
20
|
+
with:
|
|
21
|
+
node-version: ${{ matrix.node }}
|
|
22
|
+
registry-url: 'https://registry.npmjs.org'
|
|
23
|
+
- run: npm install
|
|
24
|
+
- name: 🚀 publish
|
|
25
|
+
run: npm publish --access public
|
|
26
|
+
env:
|
|
27
|
+
NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}
|
package/README.md
CHANGED
|
@@ -1,11 +1,31 @@
|
|
|
1
1
|
# dorky
|
|
2
|
-
|
|
2
|
+
```
|
|
3
|
+
__ __
|
|
4
|
+
.--| .-----.----| |--.--.--.
|
|
5
|
+
| _ | _ | _| <| | |
|
|
6
|
+
|_____|_____|__| |__|__|___ |
|
|
7
|
+
|_____|
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
`DevOps Records Keeper`
|
|
11
|
+
|
|
12
|
+
[](https://npmjs.com/package/dorky)
|
|
13
|
+
|
|
14
|
+
 `&& ` 
|
|
15
|
+
|
|
16
|
+
Let us assume that we need to create a project.
|
|
17
|
+
|
|
18
|
+
The project obviously contains some code and some secret variables like database information, API keys, etc. This data cannot be shared on public VCS (GitHub), but at times is required to be accessible remotely to be shared among reliable sources.
|
|
19
|
+
|
|
20
|
+
Anyhow, we shall store it on a private storage, using **dorky**, that stores it on a S3.
|
|
3
21
|
|
|
4
22
|
## Steps to use:
|
|
5
23
|
|
|
6
|
-
>
|
|
24
|
+
> Create a S3 bucket, AWS_ACCESS_KEY and AWS_SECRET_KEY.
|
|
25
|
+
|
|
26
|
+
|
|
7
27
|
|
|
8
|
-
>
|
|
28
|
+
> Please use your own repository, this repository `sample_project` is just for demonstration.
|
|
9
29
|
|
|
10
30
|
### To push files to S3 bucket.
|
|
11
31
|
1. Initialize dorky setup in the root folder of your project, using `dorky init`.
|