1datalad create-sibling-gitea(G1e)neral Commands Manduaatlalad create-sibling-gitea(1)
2
6 datalad create-sibling-gitea - create a dataset sibling on a Gitea site
7
9 datalad create-sibling-gitea [-h] [--dataset DATASET] [-r] [-R LEVELS]
10 [-s NAME] [--existing {skip|error|reconfigure|replace}]
11 [--api URL] [--credential NAME] [--access-protocol
12 {https|ssh|https-ssh}] [--publish-depends SIBLINGNAME]
13 [--private] [--description DESCRIPTION] [--dry-run] [--version]
14 [<org-name>/]<repo-(base)name>
15
19 Gitea is a lightweight, free and open source code hosting solution with
20 low resource demands that enable running it on inexpensive devices like
21 a Raspberry Pi.
22 This command uses the main Gitea instance at https://gitea.com as the
24 default target, but other deployments can be used via the 'api' parame‐
25 ter.
26 In order to be able to use this command, a personal access token has to
28 be generated on the platform (Account->Settings->Applications->Generate
29 Token).
30 This command can be configured with "datalad.create-sibling-ghlike.ex‐
32 tra-remote-settings.NETLOC.KEY=VALUE" in order to add any local KEY =
33 VALUE configuration to the created sibling in the local `.git/config`
34 file. NETLOC is the domain of the Gitea instance to apply the configu‐
35 ration for. This leads to a behavior that is equivalent to calling
36 datalad's ``siblings('configure', ...)``||``siblings configure`` com‐
37 mand with the respective KEY-VALUE pair after creating the sibling.
38 The configuration, like any other, could be set at user- or system lev‐
39 el, so users do not need to add this configuration to every sibling
40 created with the service at NETLOC themselves.
41 New in version 0.16
43
45 [<org-name>/]<repo-(base)name>
46 repository name, optionally including an '<organization>/' pre‐
47 fix if the repository shall not reside under a user's namespace.
48 When operating recursively, a suffix will be appended to this
49 name for each subdataset. Constraints: value must be a string
50 -h, --help, --help-np
53 show this help message. --help-np forcefully disables the use of
54 a pager for displaying the help message
55 --dataset DATASET, -d DATASET
57 dataset to create the publication target for. If not given, an
58 attempt is made to identify the dataset based on the current
59 working directory. Constraints: Value must be a Dataset or a
60 valid identifier of a Dataset (e.g. a path) or value must be
61 NONE
62 -r, --recursive
64 if set, recurse into potential subdatasets.
65 -R LEVELS, --recursion-limit LEVELS
67 limit recursion into subdatasets to the given number of levels.
68 Constraints: value must be convertible to type 'int' or value
69 must be NONE
70 -s NAME, --name NAME
72 name of the sibling in the local dataset installation (remote
73 name). Constraints: value must be a string or value must be NONE
74 [Default: 'gitea']
75 --existing {skip|error|reconfigure|replace}
77 behavior when already existing or configured siblings are dis‐
78 covered: skip the dataset ('skip'), update the configuration
79 ('reconfigure'), or fail ('error'). DEPRECATED DANGER ZONE: With
80 'replace', an existing repository will be irreversibly removed,
81 re-initialized, and the sibling (re-)configured (thus implies
82 'reconfigure'). REPLACE could lead to data loss! In interactive
83 sessions a confirmation prompt is shown, an exception is raised
84 in non-interactive sessions. The 'replace' mode will be removed
85 in a future release. Constraints: value must be one of ('skip',
86 'error', 'reconfigure', 'replace') [Default: 'error']
87 --api URL
89 URL of the Gitea instance without a 'api/<version>' suffix. Con‐
90 straints: value must be a string or value must be NONE [Default:
91 'https://gitea.com']
92 --credential NAME
94 name of the credential providing a personal access token to be
95 used for authorization. The token can be supplied via configura‐
96 tion setting 'datalad.credential.<name>.token', or environment
97 variable DATALAD_CREDENTIAL_<NAME>_TOKEN, or will be queried
98 from the active credential store using the provided name. If
99 none is provided, the host-part of the API URL is used as a name
100 (e.g. 'https://api.github.com' -> 'api.github.com'). Con‐
101 straints: value must be a string or value must be NONE
102 --access-protocol {https|ssh|https-ssh}
104 access protocol/URL to configure for the sibling. With 'https-
105 ssh' SSH will be used for write access, whereas HTTPS is used
106 for read access. Constraints: value must be one of ('https',
107 'ssh', 'https-ssh') [Default: 'https']
108 --publish-depends SIBLINGNAME
110 add a dependency such that the given existing sibling is always
111 published prior to the new sibling. This equals setting a con‐
112 figuration item 'remote.SIBLINGNAME.datalad-publish-depends'.
113 This option can be given more than once to configure multiple
114 dependencies. Constraints: value must be a string or value must
115 be NONE
116 --private
118 if set, create a private repository.
119 --description DESCRIPTION
121 Brief description, displayed on the project's page. Constraints:
122 value must be a string or value must be NONE
123 --dry-run
125 if set, no repository will be created, only tests for sibling
126 name collisions will be performed, and would-be repository names
127 are reported for all relevant datasets.
128 --version
130 show the module and its version which provides the command
131
133 datalad is developed by The DataLad Team and Contributors <team@datal‐
134 ad.org>.
135datalad create-sibling-gitea 0.19.32023-08-11 datalad create-sibling-gitea(1)