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
|
// file : bdep/publish.cli
// copyright : Copyright (c) 2014-2018 Code Synthesis Ltd
// license : MIT; see accompanying LICENSE file
include <bdep/project.cli>;
"\section=1"
"\name=bdep-publish"
"\summary=publish project to archive repository"
namespace bdep
{
{
"<options>
<prj-spec> <prj-dir>
<pkg-spec> <pkg-dir>
<cfg-spec> <cfg-name> <cfg-dir>",
"\h|SYNOPSIS|
\c{\b{bdep publish} [<options>] [<cfg-spec>] [<pkg-spec>]}
\c{<pkg-spec> = (\b{--directory}|\b{-d} <pkg-dir>)... | <prj-spec>\n
<prj-spec> = \b{--directory}|\b{-d} <prj-dir>\n
<cfg-spec> = \b{@}<cfg-name> | \b{--config}|\b{-c} <cfg-dir>}
\h|DESCRIPTION|
The \cb{publish} command publishes the project packages to an
archive-based repository.
If no project or package directory is specified, then the current working
directory is assumed. If no configuration is specified, then the default
configuration is used to prepare the package distributions. If the
specified directory is a project directory, then all the packages in the
project are published. See \l{bdep-projects-configs(1)} for details on
specifying projects and configurations.
For each specified package the \cb{publish} command prepares a package
archive and sends it as part of the package submission request to an
archive-based repository. If the repository is not explicitly specified
with the \cb{--repository} option, packages are published to
\cb{cppget.org} by default.
Along with the package archive, the submission request specifies the
repository section to publish the package under, the control repository
URL to use for authorization, and the publisher's name and email address
for the record. While the exact usage and interpretation of this
information depends on the specific repository, the following semantics
apply when submitting to \cb{cppget.org}.
The section specifies the desired repository section to publish the
project under. If not explicitly specified with the \cb{--section}
option, one of the \cb{alpha}, \cb{beta}, or \cb{stable} values are
automatically derived from the package version.
The control repository URL is a publicly accessible, read-only URL to a
version control repository (normally the same as the project's) that is
used to authenticate the publisher as someone authorized to publish under
this package name (currently only \cb{git(1)} is supported).
Prior to sending the submission request, the \cb{publish} command adds
the package archive checksum to the \cb{build2-control} branch of the
project's version control repository. Upon receiving the submission
request, the archive repository either (1) associates the control
repository with the package name if this is the first time this package
name is published or (2) compares the submitted control repository to the
previously associated and, if matching, queries the \cb{build2-control}
branch to verify that the submitter is authorized to publish this archive
under this package name.
Unless the control repository URL is specified with the \cb{--control}
option, it will be automatically derived from the version control's
\"remote\" URL. In case of \cb{git(1)}, it will be based on the
\cb{remote.origin.url} configuration value unless overridden with
\cb{remote.origin.build2ControlUrl} or \cb{remote.origin.build2Url}. The
special \cb{none} value to the \cb{--control} option can be used to
disable this functionality.
See \l{brep#submit Package Submission} for details on the submission
request handling by archive repositories.
"
}
class cmd_publish_options: project_options
{
"\h|PUBLISH OPTIONS|"
bool --yes|-y
{
"Don't prompt for confirmation before publishing."
}
string --control
{
"<url>",
"Control repository URL for the packages being published."
}
url --repository = "https://cppget.org"
{
"<url>",
"Repository to publish the packages to."
}
string --section
{
"<name>",
"Repository section to publish the packages under."
}
string --author-name
{
"<name>",
"Publisher's name. If unspecified, it will be obtained from the
environment and/or version control system. See the ENVIRONMENT
section for details."
}
string --author-email
{
"<email>",
"Publisher's email address. If unspecified, it will be obtained from the
environment and/or version control system. See the ENVIRONMENT section
for details."
}
string --simulate
{
"<outcome>",
"Simulate the specified outcome of the submission process without
actually performing any externally visible actions (such as publishing
the package). The commonly used outcome value is \cb{success}. For
other recognized outcomes refer to the submission service
documentation."
}
};
"\h|ENVIRONMENT|
The \cb{BDEP_AUTHOR_NAME} and \cb{BDEP_AUTHOR_EMAIL} environment variables
can be used to specify the publisher's name and email address,
respectively. If not set, the \cb{publish} command will first try to obtain
the name and email from the version control system (if used) and then from
the \cb{USER} and \cb{EMAIL} environment variables, respectively. See also
the \cb{--author-name} and \cb{--author-email} options.
"
}
|
