storyblok-backup 0.0.1 → 0.0.2
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/README.md +11 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,12 +27,13 @@ The script will fetch the following resources of a Storyblok space using the Man
|
|
|
27
27
|
## Installation
|
|
28
28
|
|
|
29
29
|
```shell
|
|
30
|
-
# install globally
|
|
31
|
-
$ npm install -g storyblok-backup
|
|
32
30
|
|
|
33
|
-
#
|
|
31
|
+
# simply auto-download and run via npx
|
|
34
32
|
$ npx storyblok-backup
|
|
35
33
|
|
|
34
|
+
# or install globally
|
|
35
|
+
$ npm install -g storyblok-backup
|
|
36
|
+
|
|
36
37
|
# or install for project using npm
|
|
37
38
|
$ npm install storyblok-backup
|
|
38
39
|
|
|
@@ -45,6 +46,8 @@ $ pnpm add storyblok-backup
|
|
|
45
46
|
|
|
46
47
|
## Usage
|
|
47
48
|
|
|
49
|
+
Call `npx storyblok-backup` with the following options:
|
|
50
|
+
|
|
48
51
|
### Options
|
|
49
52
|
|
|
50
53
|
```text
|
|
@@ -100,8 +103,10 @@ on:
|
|
|
100
103
|
- cron: '0 0 * * 0'
|
|
101
104
|
|
|
102
105
|
jobs:
|
|
103
|
-
|
|
106
|
+
backup:
|
|
104
107
|
runs-on: ubuntu-latest
|
|
108
|
+
permissions:
|
|
109
|
+
actions: write
|
|
105
110
|
|
|
106
111
|
steps:
|
|
107
112
|
- name: Perform Backup
|
|
@@ -142,6 +147,8 @@ jobs:
|
|
|
142
147
|
|
|
143
148
|
Make sure, to set the secrets `STORYBLOK_OAUTH_TOKEN` and `STORYBLOK_SPACE_ID` in your repository settings.
|
|
144
149
|
|
|
150
|
+
Note that artifact manipulation requires the `actions: write` permission for the workflow. The workflow above has this permission set already.
|
|
151
|
+
|
|
145
152
|
If you create multiple workflows for daily, weekly and monthly backups, by changing the cron-schedule and the two occurrences of the artifact name `weekly-backup`, you will always have exactly one daily, weekly and monthly backup.
|
|
146
153
|
|
|
147
154
|
Also keep in mind, that there is a limit on artifact storage and runner minutes ([see GitHub docs](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#included-storage-and-minutes)).
|