Merge pull request #1944 from apache/abderrahim/news-2.3.0

Update NEWS for 2.3.0
apache · Aug 8, 2024 · 6d8b4e2 · 6d8b4e2
2 parents bddbfef + 967a8b2
commit 6d8b4e2
Show file tree

Hide file tree

Showing 27 changed files with 54 additions and 27 deletions.
diff --git a/NEWS b/NEWS
@@ -1,3 +1,29 @@
+=================
+buildstream 2.3.0
+=================
+
+  o Proxy remote asset and remote execution requests via buildbox-casd (#1922, #1926)
+
+  o Optimize bst show when no cached state is needed (#1923)
+
+  o Support %{description} in bst show commands
+
+  o Support HTTP Bearer authentication for remote API servers (#1925)
+
+  o Drop support for Python 3.7 (#1933, #1934, #1936)
+
+  o downloadablefilesource: Add 10 minutes timeout (#1928)
+
+  o tar.py: Always check member paths (#1932)
+
+  o Ensure blobs are available locally when using storage-service (#1938)
+
+  o Support loading source mirror plugins from pip and junction origins (#1931)
+
+  o Restore terminal after exiting a bst shell (#1786)
+
+  o Fail early if buildbox-run is present but non-functional (#1746)
+
 =================
 buildstream 2.2.1
 =================

diff --git a/doc/examples/first-project/project.conf b/doc/examples/first-project/project.conf
@@ -2,7 +2,7 @@
 name: first-project
 
 # Required BuildStream version
-min-version: 2.2
+min-version: 2.3
 
 # Subdirectory where elements are stored
 element-path: elements
diff --git a/man/bst-artifact-checkout.1 b/man/bst-artifact-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT CHECKOUT" "1" "2024-04-17" "" "bst artifact checkout Manual"
+.TH "BST ARTIFACT CHECKOUT" "1" "2024-08-08" "" "bst artifact checkout Manual"
 .SH NAME
 bst\-artifact\-checkout \- Checkout contents of an artifact
 .SH SYNOPSIS

diff --git a/man/bst-artifact-delete.1 b/man/bst-artifact-delete.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT DELETE" "1" "2024-04-17" "" "bst artifact delete Manual"
+.TH "BST ARTIFACT DELETE" "1" "2024-08-08" "" "bst artifact delete Manual"
 .SH NAME
 bst\-artifact\-delete \- Remove artifacts from the local cache
 .SH SYNOPSIS

diff --git a/man/bst-artifact-list-contents.1 b/man/bst-artifact-list-contents.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT LIST-CONTENTS" "1" "2024-04-17" "" "bst artifact list-contents Manual"
+.TH "BST ARTIFACT LIST-CONTENTS" "1" "2024-08-08" "" "bst artifact list-contents Manual"
 .SH NAME
 bst\-artifact\-list-contents \- List the contents of an artifact
 .SH SYNOPSIS

diff --git a/man/bst-artifact-log.1 b/man/bst-artifact-log.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT LOG" "1" "2024-04-17" "" "bst artifact log Manual"
+.TH "BST ARTIFACT LOG" "1" "2024-08-08" "" "bst artifact log Manual"
 .SH NAME
 bst\-artifact\-log \- Show logs of artifacts
 .SH SYNOPSIS

diff --git a/man/bst-artifact-pull.1 b/man/bst-artifact-pull.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PULL" "1" "2024-04-17" "" "bst artifact pull Manual"
+.TH "BST ARTIFACT PULL" "1" "2024-08-08" "" "bst artifact pull Manual"
 .SH NAME
 bst\-artifact\-pull \- Pull a built artifact
 .SH SYNOPSIS

diff --git a/man/bst-artifact-push.1 b/man/bst-artifact-push.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT PUSH" "1" "2024-04-17" "" "bst artifact push Manual"
+.TH "BST ARTIFACT PUSH" "1" "2024-08-08" "" "bst artifact push Manual"
 .SH NAME
 bst\-artifact\-push \- Push a built artifact
 .SH SYNOPSIS

diff --git a/man/bst-artifact-show.1 b/man/bst-artifact-show.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT SHOW" "1" "2024-04-17" "" "bst artifact show Manual"
+.TH "BST ARTIFACT SHOW" "1" "2024-08-08" "" "bst artifact show Manual"
 .SH NAME
 bst\-artifact\-show \- Show the cached state of artifacts
 .SH SYNOPSIS

diff --git a/man/bst-artifact.1 b/man/bst-artifact.1
@@ -1,4 +1,4 @@
-.TH "BST ARTIFACT" "1" "2024-04-17" "" "bst artifact Manual"
+.TH "BST ARTIFACT" "1" "2024-08-08" "" "bst artifact Manual"
 .SH NAME
 bst\-artifact \- Manipulate cached artifacts.
 .SH SYNOPSIS

diff --git a/man/bst-build.1 b/man/bst-build.1
@@ -1,4 +1,4 @@
-.TH "BST BUILD" "1" "2024-04-17" "" "bst build Manual"
+.TH "BST BUILD" "1" "2024-08-08" "" "bst build Manual"
 .SH NAME
 bst\-build \- Build elements in a pipeline
 .SH SYNOPSIS

diff --git a/man/bst-help.1 b/man/bst-help.1
@@ -1,4 +1,4 @@
-.TH "BST HELP" "1" "2024-04-17" "" "bst help Manual"
+.TH "BST HELP" "1" "2024-08-08" "" "bst help Manual"
 .SH NAME
 bst\-help \- Print usage information
 .SH SYNOPSIS

diff --git a/man/bst-init.1 b/man/bst-init.1
@@ -1,4 +1,4 @@
-.TH "BST INIT" "1" "2024-04-17" "" "bst init Manual"
+.TH "BST INIT" "1" "2024-08-08" "" "bst init Manual"
 .SH NAME
 bst\-init \- Initialize a new BuildStream project
 .SH SYNOPSIS
@@ -19,7 +19,7 @@ Initialize a new BuildStream project
 The project name to use
 .TP
 \fB\-\-min\-version\fP TEXT
-The required format version  [default: 2.2]
+The required format version  [default: 2.3]
 .TP
 \fB\-\-element\-path\fP PATH
 The subdirectory to store elements in  [default: elements]

diff --git a/man/bst-shell.1 b/man/bst-shell.1
@@ -1,4 +1,4 @@
-.TH "BST SHELL" "1" "2024-04-17" "" "bst shell Manual"
+.TH "BST SHELL" "1" "2024-08-08" "" "bst shell Manual"
 .SH NAME
 bst\-shell \- Shell into an element's sandbox environment
 .SH SYNOPSIS

diff --git a/man/bst-show.1 b/man/bst-show.1
@@ -1,4 +1,4 @@
-.TH "BST SHOW" "1" "2024-04-17" "" "bst show Manual"
+.TH "BST SHOW" "1" "2024-08-08" "" "bst show Manual"
 .SH NAME
 bst\-show \- Show elements in the pipeline
 .SH SYNOPSIS
@@ -32,6 +32,7 @@ Show elements in the pipeline
 .PP
     
         %{name}           The element name
+        %{description}    The element description, on a single line (Since: 2.3)
         %{key}            The abbreviated cache key (if all sources are consistent)
         %{full-key}       The full cache key (if all sources are consistent)
         %{state}          cached, buildable, waiting, inconsistent or junction

diff --git a/man/bst-source-checkout.1 b/man/bst-source-checkout.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE CHECKOUT" "1" "2024-04-17" "" "bst source checkout Manual"
+.TH "BST SOURCE CHECKOUT" "1" "2024-08-08" "" "bst source checkout Manual"
 .SH NAME
 bst\-source\-checkout \- Checkout sources of an element
 .SH SYNOPSIS

diff --git a/man/bst-source-fetch.1 b/man/bst-source-fetch.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE FETCH" "1" "2024-04-17" "" "bst source fetch Manual"
+.TH "BST SOURCE FETCH" "1" "2024-08-08" "" "bst source fetch Manual"
 .SH NAME
 bst\-source\-fetch \- Fetch sources in a pipeline
 .SH SYNOPSIS

diff --git a/man/bst-source-push.1 b/man/bst-source-push.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE PUSH" "1" "2024-04-17" "" "bst source push Manual"
+.TH "BST SOURCE PUSH" "1" "2024-08-08" "" "bst source push Manual"
 .SH NAME
 bst\-source\-push \- Push sources in a pipeline
 .SH SYNOPSIS

diff --git a/man/bst-source-track.1 b/man/bst-source-track.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE TRACK" "1" "2024-04-17" "" "bst source track Manual"
+.TH "BST SOURCE TRACK" "1" "2024-08-08" "" "bst source track Manual"
 .SH NAME
 bst\-source\-track \- Track new source references
 .SH SYNOPSIS

diff --git a/man/bst-source.1 b/man/bst-source.1
@@ -1,4 +1,4 @@
-.TH "BST SOURCE" "1" "2024-04-17" "" "bst source Manual"
+.TH "BST SOURCE" "1" "2024-08-08" "" "bst source Manual"
 .SH NAME
 bst\-source \- Manipulate sources for an element
 .SH SYNOPSIS

diff --git a/man/bst-workspace-close.1 b/man/bst-workspace-close.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE CLOSE" "1" "2024-04-17" "" "bst workspace close Manual"
+.TH "BST WORKSPACE CLOSE" "1" "2024-08-08" "" "bst workspace close Manual"
 .SH NAME
 bst\-workspace\-close \- Close workspaces
 .SH SYNOPSIS

diff --git a/man/bst-workspace-list.1 b/man/bst-workspace-list.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE LIST" "1" "2024-04-17" "" "bst workspace list Manual"
+.TH "BST WORKSPACE LIST" "1" "2024-08-08" "" "bst workspace list Manual"
 .SH NAME
 bst\-workspace\-list \- List open workspaces
 .SH SYNOPSIS

diff --git a/man/bst-workspace-open.1 b/man/bst-workspace-open.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE OPEN" "1" "2024-04-17" "" "bst workspace open Manual"
+.TH "BST WORKSPACE OPEN" "1" "2024-08-08" "" "bst workspace open Manual"
 .SH NAME
 bst\-workspace\-open \- Open a new workspace
 .SH SYNOPSIS

diff --git a/man/bst-workspace-reset.1 b/man/bst-workspace-reset.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE RESET" "1" "2024-04-17" "" "bst workspace reset Manual"
+.TH "BST WORKSPACE RESET" "1" "2024-08-08" "" "bst workspace reset Manual"
 .SH NAME
 bst\-workspace\-reset \- Reset a workspace to its original state
 .SH SYNOPSIS

diff --git a/man/bst-workspace.1 b/man/bst-workspace.1
@@ -1,4 +1,4 @@
-.TH "BST WORKSPACE" "1" "2024-04-17" "" "bst workspace Manual"
+.TH "BST WORKSPACE" "1" "2024-08-08" "" "bst workspace Manual"
 .SH NAME
 bst\-workspace \- Manipulate developer workspaces
 .SH SYNOPSIS

diff --git a/man/bst.1 b/man/bst.1
@@ -1,4 +1,4 @@
-.TH "BST" "1" "2024-04-17" "" "bst Manual"
+.TH "BST" "1" "2024-08-08" "" "bst Manual"
 .SH NAME
 bst \- Build and manipulate BuildStream projects
 .SH SYNOPSIS

diff --git a/src/buildstream/_frontend/cli.py b/src/buildstream/_frontend/cli.py
@@ -409,7 +409,7 @@ def help_command(ctx, command):
 @click.option(
     "--min-version",
     type=click.STRING,
-    default="2.2",
+    default="2.3",
     show_default=True,
     help="The required format version",
 )