Skip to content

Commit c00bc17

Browse files
authored
update NEWS and release instructions post 1.27.6 release (#1715)
* install `bash` in `release-archive` target. The `__str` function has a bash shebang. Intended to address the error: ``` +release-archive | branch=r1.27 prefix=mongo-c-driver-1.27.6 ref=refs/tags/1.27.6 sbom_branch=r1.27 version=1.27.6 +release-archive | --> IF __str test "$version" -matches ".*\.0\$" +release-archive | env: can't execute 'bash': No such file or directory ``` * document how to obtain secrets * show examples for `RELEASE_BRANCH` and `NEW_VERSION` * remove redundant `BRANCH` variable and reuse `RELEASE_BRANCH` * update NEWS for 1.27.6
1 parent 1ffb42d commit c00bc17

File tree

5 files changed

+50
-8
lines changed

5 files changed

+50
-8
lines changed

Earthfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ multibuild:
175175
# Create a release archive of the source tree. (Refer to dev docs)
176176
release-archive:
177177
FROM alpine:3.20
178-
RUN apk add git
178+
RUN apk add git bash
179179
ARG --required sbom_branch
180180
ARG --required prefix
181181
ARG --required ref

NEWS

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,27 @@ Deprecated:
3333

3434
* A future minor release plans to drop support for Visual Studio 2013.
3535

36+
libmongoc 1.27.6
37+
================
38+
39+
Fixes:
40+
41+
* Fix TSan warning.
42+
* Fix C23 compile.
43+
44+
Improvements:
45+
46+
* Document expected behavior of command errors in a transaction.
47+
48+
Thanks to everyone who contributed to the development of this release.
49+
50+
* Adrian Dole
51+
* Ezra Chung
52+
* Joshua Siegel
53+
* Kevin Albertson
54+
55+
56+
3657
libmongoc 1.27.5
3758
================
3859

docs/dev/earthly.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,12 +316,17 @@ enumerated using ``earthly ls`` or ``earthly doc`` in the root of the repository
316316

317317
**Do not** use the organization ID of **mongodb-default**.
318318

319+
The `SNYK_ORGANIZATION` may be obtained from the `Snyk organization page
320+
<https://app.snyk.io/org/dev-prod/manage/settings>`_.
321+
319322
.. _snyk: https://app.snyk.io
320323

321324
.. envvar:: SNYK_TOKEN
322325

323326
Set this to the value of an API token for accessing Snyk in the given
324-
`SNYK_ORGANIZATION`. [#creds]_
327+
`SNYK_ORGANIZATION`.
328+
329+
The `SNYK_TOKEN` may be obtained from the `Snyk account page <https://app.snyk.io/account>`_.
325330

326331
.. program:: +snyk-test
327332
.. earthly-target:: +snyk-test
@@ -379,4 +384,6 @@ during execution. Your ``.secret`` file will look something like this:
379384
380385
.. [#creds]
381386
382-
Details on obtaining credentials will not be found in this documentation.
387+
Credentials are expected to be available in `AWS Secrets Manager
388+
<https://wiki.corp.mongodb.com/display/DRIVERS/Using+AWS+Secrets+Manager+to+Store+Testing+Secrets>`_ under
389+
``drivers/c-driver``.

docs/dev/releasing.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ To enable Snyk monitoring for a release, execute the `+snyk-monitor-snapshot`
112112
Earthly target for the release branch to be monitored. Be sure to specify the
113113
correct branch name with `--branch`, and use `--name` to identify the snapshot
114114
as belonging to the new release version. Let ``$RELEASE_BRANCH`` being the name
115-
of the branch from which we are releasing, and let ``$NEW_VERSION`` be the new
116-
release version that we are posting:
115+
of the branch from which we are releasing (e.g. ``r1.27``), and let ``$NEW_VERSION`` be the new
116+
release version that we are posting (e.g. ``1.27.6``):
117117

118118
.. code-block:: console
119119
@@ -395,10 +395,9 @@ required for it to succeed:
395395
:any:`+sbom-download` targets.
396396

397397
Once these prerequesites are met, creating the release archive can be done using
398-
the :any:`+signed-release` target. Let `$BRANCH` be the name of the Git branch
399-
from which the release is being made::
398+
the :any:`+signed-release` target.::
400399

401-
$ ./tools/earthly.sh --artifact +signed-release/dist dist --sbom_branch=$BRANCH --version=$NEW_VERSION
400+
$ ./tools/earthly.sh --artifact +signed-release/dist dist --sbom_branch=$RELEASE_BRANCH --version=$NEW_VERSION
402401

403402
.. note:: `$NEW_VERSION` must correspond to the Git tag created by the release.
404403

src/libbson/NEWS

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ Build Configuration:
88
* Remove `MONGO_USE_CCACHE` (no longer applicable; see above).
99

1010

11+
libbson 1.27.6
12+
==============
13+
14+
Fixes:
15+
16+
* Fix handling of malformed extended JSON for special BSON types.
17+
* Fix large string handling in `bson_string_new` and `bson_string_append`.
18+
19+
Thanks to everyone who contributed to the development of this release.
20+
21+
* Ezra Chung
22+
* Kevin Albertson
23+
24+
25+
1126
libbson 1.27.5
1227
==============
1328

0 commit comments

Comments
 (0)