You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a Github Action that syncs a folder to a Google Cloud bucket using `rclone` and then send an authenticated request to the doc site to invalidate the cache for the doc version.
4
-
This action is only meant to work for Deephaven's documentation. It could be used in a more general purpose way to sync a folder into any Google cloud bucket (with the proper credentials), but that is subject to change and may break in any version.
3
+
This is a Github Action that syncs a folder to a S3 bucket using `rclone`.
4
+
This action is only meant to work for Deephaven's documentation.
5
5
6
6
## Parameters
7
7
@@ -15,22 +15,20 @@ inputs:
15
15
required: true
16
16
type: string
17
17
description: "The destination directory to sync. Relative to the bucket. It is recommended to use the GitHub repo path (such as deephaven/salmon-sync) as the minimum base to prevent collisions."
18
-
bucket:
18
+
aws-role:
19
19
required: true
20
20
type: string
21
-
description: "The Google Cloud bucket to sync to."
22
-
credentials:
23
-
required: true
24
-
type: string
25
-
description: "The Google Cloud credentials. Should be base64 encoded."
26
-
cache-bust-token:
27
-
required: true
28
-
type: string
29
-
description: "The cache-bust token"
30
-
docs-url:
31
-
required: true
32
-
type: string
33
-
description: "The doc site URL"
21
+
description: "The AWS role to assume."
22
+
production:
23
+
required: false
24
+
default: "false"
25
+
type: boolean
26
+
description: "If true, the files will be deployed to the production site. Otherwise they will be deployed to the preview site."
27
+
temporary:
28
+
required: false
29
+
default: "true"
30
+
type: boolean
31
+
description: "If true, the files will be marked as temporary and deleted after 14 days. Otherwise they will persist in S3 indefinitely."
34
32
```
35
33
36
34
## Example
@@ -44,8 +42,7 @@ Here is an example that syncs from the local path `temp/blog` to the blog sectio
44
42
with:
45
43
source: temp/blog
46
44
destination: deephaven/deephaven.io/blog
47
-
bucket: ${{ vars.DOCS_PROD_BUCKET }} # or ${{ vars.DOCS_PREVIEW_BUCKET }}
description: Syncs a directory to a Google Cloud bucket using rclone.
2
+
description: Syncs a directory to a bucket using rclone.
3
3
author: "deephaven"
4
4
inputs:
5
5
source:
@@ -10,22 +10,20 @@ inputs:
10
10
required: true
11
11
type: string
12
12
description: "The destination directory to sync. Relative to the bucket. It is recommended to use the GitHub repo path (such as deephaven/salmon-sync) as the minimum base to prevent collisions."
13
-
bucket:
13
+
aws-role:
14
14
required: true
15
15
type: string
16
-
description: "The Google Cloud bucket to sync to."
17
-
credentials:
18
-
required: true
19
-
type: string
20
-
description: "The Google Cloud credentials. Should be base64 encoded."
21
-
cache-bust-token:
22
-
required: true
23
-
type: string
24
-
description: "The cache-bust token"
25
-
docs-url:
26
-
required: true
27
-
type: string
28
-
description: "The doc site URL"
16
+
description: "The AWS role to assume."
17
+
production:
18
+
required: false
19
+
default: "false"
20
+
type: boolean
21
+
description: "If true, the files will be deployed to the production site. Otherwise they will be deployed to the preview site."
22
+
temporary:
23
+
required: false
24
+
default: "true"
25
+
type: boolean
26
+
description: "If true, the files will be marked as temporary and deleted after 14 days. Otherwise they will persist in S3 indefinitely."
0 commit comments