-
Notifications
You must be signed in to change notification settings - Fork 0
/
splitter.document.yml
129 lines (105 loc) · 4.2 KB
/
splitter.document.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# Define configurations that you often reuse in this section
# Optional
deployments: # Array<Map>
# each Mapping must have service key
firebase-app-distribution:
# firebase app distribution's service name
service: firebase-app-distribution
# An app ID. You can get this value from the firebase console's project setting. e.g. 1:123456789:android:xxxxx
# Required
app-id: string
# Access token that has permission to use App Distribution
# Required: (either access-token or credentials-path)
access-token: string
# A path to credentials file. If the both of this and access token are given, access token takes priority.
# Required: (either access-token or credentials-path)
credentials-path: string
# A list of group aliases. Each group must exist.
# Optional
group-aliases:
- string
deploygate:
# DeployGate's service name
service: deploygate
# User#name or Organization#name of DeployGate
# Required
app-owner-name: string
# API token of the app owner or who has permission to use their namespace.
# Required
api-token: string
# The existing access key of the distribution
# Optional
distribution-access-key: string
# A name of a distribution
# Optional
distribution-name: string
local:
# local's service name
service: local
# A destination file path. Absolute and/or relative paths are supported.
# Required
destination-path: string
# Specify true if you are okay to overwrite the destination file. Otherwise, this command fails.
# Optional
allow-overwrite: bool
# 0644 for example. zero value means keeping the perm mode of the source file
# Optional
file-mode: int
# Specify true if you would like to delete the source file later and the behavior looks *move* then.
# Optional
delete-source: bool
use-custom-service:
# set a name defined in services section
service: <custom-service-name>
# An auth token of this service
# Required
auth-token: string
any-services: # the following parameters are available for all services
# command calls will be executed before the deployment
# Optional
pre-steps: # [][]string
- ["cmd", "arg1", ..., "argN"]
# command calls will be executed after the successful deployment
# Optional
post-steps: # [][]string
- ["cmd", "arg1", ..., "argN"]
# Define unsupported services as custom services.
# This section cannot use variable expansion.
# Optional
services: # Array<Map>
<custom-service-name>:
# the endpoint. e.g. https://..../path/to/endpoint
# Required
endpoint: string
# specify how splitter set a source file to
# Required
#
# form_params.<name> : a form request that uses <name> field to upload a source file
# request_body : set a source file as binary
source-file-format: enum string
# specify how splitter set a token to
# Required
auth:
# form_params.<name> : a form request that uses <name> field for a token
# query_params.<name> : set a named param for a token
# headers.<name> : set a named header for a token
style-format: "headers.Authorization"
# the value format of tokens
# this value must include exact one %s
value-format: "Bearer %s"
# default values of requests
default:
headers: # map[string]string
<header_name>: header_value
form-params: # map[string]string
<field_name>: field_value
queries: # map[string][]string
<query_param>:
- value1
- value2
# The output format (Values: pretty, raw, markdown)
format-style: enum string
# read/connection timeout (infinite) e.g. 10m
network-timeout: time.Duration
# wait timeout for services' async-processing state (infinite)
wait-timeout: time.Duration e.g. 5m