grav-plugin-git-sync/blueprints.yaml at develop · trilbymedia/grav-plugin-git-sync · GitHub

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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
name: Git Sync
type: plugin
slug: git-sync
version: 3.4.8
description: Allows to synchronize portions of Grav with Git Repositories (GitHub, BitBucket, GitLab)
icon: git
author:
  name: Trilby Media, LLC
  email: hello@trilby.media
  url: http://trilby.media
homepage: http://trilby.media
keywords: grav, plugin, git, sync, github, bitbucket, gitlab
issues: https://github.com/trilbymedia/grav-plugin-git-sync/issues
docs: https://github.com/trilbymedia/grav-plugin-git-sync
license: MIT

compatibility:
  grav: ["1.7", "2.0"]

dependencies:
  - { name: grav, version: ">=1.7.0" }
  - { name: form, version: ">=3.0.0" }

form:
  validation: strict
  fields:
    Basic:
      type: section
      title: PLUGIN_GIT_SYNC.BASIC_TITLE
      underline: true

    enabled:
      type: toggle
      label: PLUGIN_ADMIN.PLUGIN_STATUS
      highlight: 1
      default: 0
      options:
        1: PLUGIN_ADMIN.ENABLED
        0: PLUGIN_ADMIN.DISABLED
      validate:
        type: bool

    sync.direction:
      type: select
      label: PLUGIN_GIT_SYNC.SYNC_DIRECTION
      size: medium
      default: both
      options:
        pull: PLUGIN_GIT_SYNC.SYNC_DIRECTION_PULL
        both: PLUGIN_GIT_SYNC.SYNC_DIRECTION_BOTH

    folders:
      type: select
      multiple: true
      label: PLUGIN_GIT_SYNC.FOLDERS
      classes: fancy
      description: PLUGIN_GIT_SYNC.FOLDERS_DESCRIPTION
      default:
        - pages
      options:
        - pages
        - themes
        - plugins
        - config
        - data
      selectize:
        create: true
      validate:
        type: commalist

    Sync:
      type: section
      title: PLUGIN_GIT_SYNC.AUTOMATIC_SYNC_TITLE
      underline: true

    SyncNotice:
      type: hidden
      markdown: true
      text: PLUGIN_GIT_SYNC.SYNC_NOTICE

    sync.on_save:
      type: toggle
      label: PLUGIN_GIT_SYNC.SYNC_ON_SAVE
      help: PLUGIN_GIT_SYNC.SYNC_ON_SAVE_HELP
      default: 1
      highlight: 1
      options:
        1: PLUGIN_ADMIN.YES
        0: PLUGIN_ADMIN.NO
      validate:
        type: bool

    sync.on_delete:
      type: toggle
      label: PLUGIN_GIT_SYNC.SYNC_ON_DELETE
      help: PLUGIN_GIT_SYNC.SYNC_ON_DELETE_HELP
      default: 1
      highlight: 1
      options:
        1: PLUGIN_ADMIN.YES
        0: PLUGIN_ADMIN.NO
      validate:
        type: bool

    sync.on_media:
      type: toggle
      label: PLUGIN_GIT_SYNC.SYNC_ON_MEDIA
      help: PLUGIN_GIT_SYNC.SYNC_ON_MEDIA_HELP
      default: 1
      highlight: 1
      options:
        1: PLUGIN_ADMIN.YES
        0: PLUGIN_ADMIN.NO
      validate:
        type: bool

    sync.cron_enable:
      type: toggle
      label: PLUGIN_GIT_SYNC.SYNC_CRON_ENABLE
      help: PLUGIN_GIT_SYNC.SYNC_CRON_ENABLE_HELP
      default: 0
      highlight: 1
      options:
        1: PLUGIN_ADMIN.YES
        0: PLUGIN_ADMIN.NO
      validate:
        type: bool

    sync.cron_at:
      type: cron
      label: PLUGIN_GIT_SYNC.SYNC_CRON_AT
      help: PLUGIN_GIT_SYNC.SYNC_CRON_AT_HELP
      default: "0 12,23 * * *"

    Repo:
      type: section
      title: PLUGIN_GIT_SYNC.REPOSITORY_TITLE
      underline: true

    local_repository:
      type: hidden
      multiple: false
      size: medium
      label: PLUGIN_GIT_SYNC.LOCAL_REPOSITORY

    repository:
      type: text
      label: PLUGIN_GIT_SYNC.GIT_REPOSITORY
      placeholder: PLUGIN_GIT_SYNC.GIT_REPOSITORY_PLACEHOLDER

    no_user:
      type: toggle
      label: PLUGIN_GIT_SYNC.NO_USER
      highlight: 0
      default: 0
      options:
        1: PLUGIN_ADMIN.ENABLED
        0: PLUGIN_ADMIN.DISABLED
      description: PLUGIN_GIT_SYNC.NO_USER_DESCRIPTION

    user:
      type: text
      label: PLUGIN_GIT_SYNC.GIT_USER
      placeholder: PLUGIN_GIT_SYNC.GIT_USER_PLACEHOLDER
      autocomplete: off

    password:
      type: enc-password
      label: PLUGIN_GIT_SYNC.GIT_PASSWORD
      placeholder: PLUGIN_GIT_SYNC.GIT_PASSWORD_PLACEHOLDER
      description: PLUGIN_GIT_SYNC.GIT_PASSWORD_DESCRIPTION
      autocomplete: off

    webhook:
      type: text
      label: PLUGIN_GIT_SYNC.WEBHOOK
      placeholder: PLUGIN_GIT_SYNC.WEBHOOK_PLACEHOLDER
      data-default@: '\Grav\Plugin\GitSyncPlugin::generateRandomWebhook'

    webhook_enabled:
      type: toggle
      label: PLUGIN_GIT_SYNC.WEBHOOK_ENABLED
      highlight: 1
      default: 0
      options:
        1: PLUGIN_ADMIN.ENABLED
        0: PLUGIN_ADMIN.DISABLED
      description: PLUGIN_GIT_SYNC.WEBHOOK_ENABLED_DESCRIPTION

    webhook_secret:
      type: text
      label: PLUGIN_GIT_SYNC.WEBHOOK_SECRET
      placeholder: PLUGIN_GIT_SYNC.WEBHOOK_SECRET_PLACEHOLDER
      data-default@: '\Grav\Plugin\GitSyncPlugin::generateWebhookSecret'
      description: PLUGIN_GIT_SYNC.WEBHOOK_SECRET_DESCRIPTION
      markdown: true

    Advanced:
      type: section
      title: PLUGIN_GIT_SYNC.ADVANCED_TITLE
      underline: true

    branch:
      type: text
      default: main
      label: PLUGIN_GIT_SYNC.BRANCH
      placeholder: PLUGIN_GIT_SYNC.BRANCH_PLACEHOLDER

    remote.name:
      type: text
      default: origin
      label: PLUGIN_GIT_SYNC.REMOTE_NAME
      placeholder: PLUGIN_GIT_SYNC.REMOTE_NAME_PLACEHOLDER

    remote.branch:
      type: text
      default: main
      label: PLUGIN_GIT_SYNC.REMOTE_BRANCH
      placeholder: PLUGIN_GIT_SYNC.REMOTE_BRANCH_PLACEHOLDER

    git.author:
      type: select
      default: gituser
      label: PLUGIN_GIT_SYNC.GIT_AUTHOR
      options:
        gituser: PLUGIN_GIT_SYNC.GIT_AUTHOR_GITUSER
        gitsync: PLUGIN_GIT_SYNC.GIT_AUTHOR_GITSYNC
        gravuser: PLUGIN_GIT_SYNC.GIT_AUTHOR_GRAVUSER
        gravfull: PLUGIN_GIT_SYNC.GIT_AUTHOR_GRAVFULL

    git.message:
      type: text
      default: (Grav GitSync) Automatic Commit
      label: PLUGIN_GIT_SYNC.GIT_MESSAGE
      placeholder: PLUGIN_GIT_SYNC.GIT_MESSAGE_PLACEHOLDER
      help: PLUGIN_GIT_SYNC.GIT_MESSAGE_HELP

    git.name:
      type: text
      default: GitSync
      label: PLUGIN_GIT_SYNC.GIT_NAME
      placeholder: PLUGIN_GIT_SYNC.GIT_NAME_PLACEHOLDER

    git.email:
      type: text
      default: git-sync@trilby.media
      label: PLUGIN_GIT_SYNC.GIT_EMAIL
      placeholder: PLUGIN_GIT_SYNC.GIT_EMAIL_PLACEHOLDER

    git.bin:
      type: text
      default: git
      label: PLUGIN_GIT_SYNC.GIT_BINARY
      help: PLUGIN_GIT_SYNC.GIT_BINARY_HELP
      placeholder: PLUGIN_GIT_SYNC.GIT_BINARY_PLACEHOLDER

    git.ignore:
      type: textarea
      label: PLUGIN_GIT_SYNC.GIT_IGNORE
      help: PLUGIN_GIT_SYNC.GIT_IGNORE_HELP
      rows: 6
      placeholder: PLUGIN_GIT_SYNC.GIT_IGNORE_PLACEHOLDER

    git.private_key:
      type: text
      label: PLUGIN_GIT_SYNC.PRIVATE_SSH_KEY
      placeholder: PLUGIN_GIT_SYNC.PRIVATE_SSH_KEY_PLACEHOLDER
      markdown: true
      description: PLUGIN_GIT_SYNC.PRIVATE_SSH_KEY_DESCRIPTION

    logging:
      type: toggle
      default: 0
      label: PLUGIN_GIT_SYNC.LOGGING
      help: PLUGIN_GIT_SYNC.LOGGING_HELP
      highlight: 0
      options:
        1: PLUGIN_ADMIN.YES
        0: PLUGIN_ADMIN.NO
      validate:
        type: bool

    Actions:
      type: section
      title: PLUGIN_GIT_SYNC.ACTIONS_TITLE
      underline: true

    _wizard:
      type: git-wizard
      label: PLUGIN_GIT_SYNC.WIZARD
      help: PLUGIN_GIT_SYNC.WIZARD_HELP