-
Notifications
You must be signed in to change notification settings - Fork 3
/
tag_and_release.html
330 lines (293 loc) · 17.6 KB
/
tag_and_release.html
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<!--
-- Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
-- SPDX-License-Identifier: Apache-2.0
-->
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>continuous_delivery_scripts.tag_and_release API documentation</title>
<meta name="description" content="Orchestrates release process." />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>continuous_delivery_scripts.tag_and_release</code></h1>
</header>
<section id="section-intro">
<p>Orchestrates release process.</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2023 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
"""Orchestrates release process."""
import argparse
import datetime
import logging
import sys
from pathlib import Path
from typing import Optional, Tuple, Dict
from continuous_delivery_scripts.generate_docs import generate_documentation
from continuous_delivery_scripts.generate_news import version_project
from continuous_delivery_scripts.language_specifics import get_language_specifics
from continuous_delivery_scripts.license_files import insert_licence_header
from continuous_delivery_scripts.report_third_party_ip import generate_spdx_project_reports, SpdxProject
from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
from continuous_delivery_scripts.utils.definitions import CommitType
from continuous_delivery_scripts.utils.git_helpers import ProjectTempClone, LocalProjectRepository, GitWrapper
from continuous_delivery_scripts.utils.logging import log_exception, set_log_level
from continuous_delivery_scripts.utils.versioning import determine_version_shortcuts
SPDX_REPORTS_DIRECTORY = "licensing"
logger = logging.getLogger(__name__)
def tag_and_release(mode: CommitType, current_branch: Optional[str] = None) -> None:
"""Tags and releases.
Updates repository with changes and releases package to PyPI for general availability.
Args:
mode: release mode
current_branch: current branch in case the current branch cannot easily
be determined (e.g. on CI)
"""
get_language_specifics().check_credentials()
is_new_version, version, version_elements = version_project(mode)
logger.info(f"Current version: {version}")
if not version:
raise ValueError("Undefined version.")
if mode == CommitType.DEVELOPMENT:
return
# The documentation folder will be emptied when the documentation is updated
_update_documentation()
# Adding the licensing summaries in /docs after folder has been cleared and regenerated.
spdx_project = _update_licensing_summary()
insert_licence_header(0)
_update_repository(mode, is_new_version, version, current_branch, version_elements)
if is_new_version:
if get_language_specifics().should_clean_before_packaging():
_clean_repository()
if spdx_project and get_language_specifics().should_include_spdx_in_package():
_generate_spdx_reports(spdx_project)
get_language_specifics().package_software(mode, version)
get_language_specifics().release_package_to_repository(mode, version)
def _get_documentation_config() -> Tuple[Path, str]:
docs_dir = Path(configuration.get_value(ConfigurationVariable.DOCUMENTATION_PRODUCTION_OUTPUT_PATH))
module_to_document = configuration.get_value(ConfigurationVariable.MODULE_TO_DOCUMENT)
return docs_dir, module_to_document
def _update_documentation() -> None:
"""Ensures the documentation is in the correct location for releasing."""
docs_dir, module_to_document = _get_documentation_config()
generate_documentation(docs_dir, module_to_document)
def _update_licensing_summary() -> Optional[SpdxProject]:
if not get_language_specifics().can_get_project_metadata():
return None
project = get_language_specifics().get_current_spdx_project()
if project:
project.generate_licensing_summary(
Path(configuration.get_value(ConfigurationVariable.DOCUMENTATION_PRODUCTION_OUTPUT_PATH))
)
return project
def _update_repository(
mode: CommitType,
is_new_version: bool,
version: str,
current_branch: Optional[str],
version_elements: Dict[str, str],
) -> None:
"""Update repository with changes that happened."""
with ProjectTempClone(desired_branch_name=current_branch) as git:
git.configure_for_github()
time_str = datetime.datetime.utcnow().strftime("%Y-%m-%d %H:%M")
commit_message = f"🚀 releasing version {version} @ {time_str}" if is_new_version else "📰 Automatic changes ⚙"
if mode == CommitType.RELEASE:
_commit_release_changes(git, version, commit_message)
if is_new_version:
get_language_specifics().tag_release(
git,
version,
determine_version_shortcuts(
mode,
configuration.get_value(ConfigurationVariable.TAG_LATEST),
configuration.get_value(ConfigurationVariable.TAG_VERSION_SHORTCUTS),
version_elements,
),
)
git.force_push_tag()
def _clean_repository() -> None:
"""Cleans the local repository."""
with LocalProjectRepository() as git:
logger.info("Cleaning repository")
git.stash()
git.clean()
git.fetch()
git.pull()
git.clean()
def _generate_spdx_reports(project: SpdxProject) -> None:
report_directory = Path(configuration.get_value(ConfigurationVariable.PROJECT_ROOT)).joinpath(
SPDX_REPORTS_DIRECTORY
)
report_directory.mkdir(exist_ok=True)
generate_spdx_project_reports(project, report_directory)
def _add_version_changes(git: GitWrapper) -> None:
git.add(configuration.get_value(ConfigurationVariable.VERSION_FILE_PATH))
git.add(configuration.get_value(ConfigurationVariable.CHANGELOG_FILE_PATH))
git.add(configuration.get_value(ConfigurationVariable.NEWS_DIR))
def _commit_release_changes(git: GitWrapper, version: str, commit_message: str) -> None:
logger.info(f"Committing release [{version}]...")
git.add(configuration.get_value(ConfigurationVariable.DOCUMENTATION_PRODUCTION_OUTPUT_PATH))
_add_version_changes(git)
_commit_changes(commit_message, git)
def _commit_changes(commit_message: str, git: GitWrapper) -> None:
git.commit(f"{commit_message}\n[skip ci]")
git.push()
git.pull()
def main() -> None:
"""Commands.
Returns:
success code (0) if successful; failure code otherwise.
"""
parser = argparse.ArgumentParser(description="Releases the project.")
parser.add_argument(
"-t", "--release-type", help="type of release to perform", required=True, type=str, choices=CommitType.choices()
)
parser.add_argument("-b", "--current-branch", help="Name of the current branch", nargs="?")
parser.add_argument("-v", "--verbose", action="count", default=0, help="Verbosity, by default errors are reported.")
args = parser.parse_args()
set_log_level(args.verbose)
try:
tag_and_release(CommitType.parse(args.release_type), args.current_branch)
except Exception as e:
log_exception(logger, e)
sys.exit(1)
if __name__ == "__main__":
main()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="continuous_delivery_scripts.tag_and_release.main"><code class="name flex">
<span>def <span class="ident">main</span></span>(<span>) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Commands.</p>
<h2 id="returns">Returns</h2>
<p>success code (0) if successful; failure code otherwise.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def main() -> None:
"""Commands.
Returns:
success code (0) if successful; failure code otherwise.
"""
parser = argparse.ArgumentParser(description="Releases the project.")
parser.add_argument(
"-t", "--release-type", help="type of release to perform", required=True, type=str, choices=CommitType.choices()
)
parser.add_argument("-b", "--current-branch", help="Name of the current branch", nargs="?")
parser.add_argument("-v", "--verbose", action="count", default=0, help="Verbosity, by default errors are reported.")
args = parser.parse_args()
set_log_level(args.verbose)
try:
tag_and_release(CommitType.parse(args.release_type), args.current_branch)
except Exception as e:
log_exception(logger, e)
sys.exit(1)</code></pre>
</details>
</dd>
<dt id="continuous_delivery_scripts.tag_and_release.tag_and_release"><code class="name flex">
<span>def <span class="ident">tag_and_release</span></span>(<span>mode: <a title="continuous_delivery_scripts.utils.definitions.CommitType" href="utils/definitions.html#continuous_delivery_scripts.utils.definitions.CommitType">CommitType</a>, current_branch: Optional[str] = None) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Tags and releases.</p>
<p>Updates repository with changes and releases package to PyPI for general availability.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>mode</code></strong></dt>
<dd>release mode</dd>
<dt><strong><code>current_branch</code></strong></dt>
<dd>current branch in case the current branch cannot easily</dd>
</dl>
<p>be determined (e.g. on CI)</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def tag_and_release(mode: CommitType, current_branch: Optional[str] = None) -> None:
"""Tags and releases.
Updates repository with changes and releases package to PyPI for general availability.
Args:
mode: release mode
current_branch: current branch in case the current branch cannot easily
be determined (e.g. on CI)
"""
get_language_specifics().check_credentials()
is_new_version, version, version_elements = version_project(mode)
logger.info(f"Current version: {version}")
if not version:
raise ValueError("Undefined version.")
if mode == CommitType.DEVELOPMENT:
return
# The documentation folder will be emptied when the documentation is updated
_update_documentation()
# Adding the licensing summaries in /docs after folder has been cleared and regenerated.
spdx_project = _update_licensing_summary()
insert_licence_header(0)
_update_repository(mode, is_new_version, version, current_branch, version_elements)
if is_new_version:
if get_language_specifics().should_clean_before_packaging():
_clean_repository()
if spdx_project and get_language_specifics().should_include_spdx_in_package():
_generate_spdx_reports(spdx_project)
get_language_specifics().package_software(mode, version)
get_language_specifics().release_package_to_repository(mode, version)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="continuous_delivery_scripts" href="index.html">continuous_delivery_scripts</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="continuous_delivery_scripts.tag_and_release.main" href="#continuous_delivery_scripts.tag_and_release.main">main</a></code></li>
<li><code><a title="continuous_delivery_scripts.tag_and_release.tag_and_release" href="#continuous_delivery_scripts.tag_and_release.tag_and_release">tag_and_release</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>