Skip to content

Commit f7740a6

Browse files
committed
Merge branch 'master' into docsp-44476-remove-methods
2 parents 57fb380 + 1d75584 commit f7740a6

File tree

4 files changed

+46
-8
lines changed

4 files changed

+46
-8
lines changed

.github/workflows/add-netlify-links.yml

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,25 @@ jobs:
2121
files: source/**
2222
- name: Build Netlify Links for Changed Pages
2323
id: build_page_links
24+
env:
25+
CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
2426
run: |
27+
# Function to validate file paths
28+
validate_file_path() {
29+
local file_path="$1"
30+
# Allow only alphanumeric characters, _ . / and -
31+
if [[ ! "$file_path" =~ ^[a-zA-Z0-9._/-]+$ ]]; then
32+
echo "Invalid file path detected: $file_path" >&2
33+
exit 1
34+
fi
35+
}
36+
2537
new_links=""
2638
base_link='https://deploy-preview-${{ github.event.number }}--mongodb-docs-csharp.netlify.app'
27-
changed_files=${{ steps.changed-files.outputs.all_changed_files }}
28-
files=$(echo $changed_files | tr "," "\n")
39+
files=$(echo "$CHANGED_FILES" | tr "," "\n")
2940
for file in $files; do
3041
echo "processing ${file}"
42+
validate_file_path "$file"
3143
if (! grep -s "includes/" <<< $file) &&
3244
(! grep -s "images/" <<< $file) &&
3345
(! grep -s "examples/" <<< $file); then

config/redirects

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
define: prefix docs/drivers/csharp
22
define: base https://www.mongodb.com/${prefix}
3-
define: versions v2.19 v2.20 v2.21 v2.22 v2.23 v2.24 v2.25 v2.26 v2.27 v2.28 v2.29 v2.30 master
3+
define: versions v2.19 v2.20 v2.21 v2.22 v2.23 v2.24 v2.25 v2.26 v2.27 v2.28 v2.29 v2.30 v3.0 master
44

55
symlink: current -> master
66

@@ -14,3 +14,5 @@ raw: ${prefix}/master -> ${base}/upcoming/
1414
[*-master]: ${prefix}/${version}/fundamentals/data-formats/polymorphism/ -> ${base}/${version}/fundamentals/serialization/polymorphic-objects/
1515
[*-master]: ${prefix}/${version}/fundamentals/data-formats/bson/ -> ${base}/${version}/fundamentals/bson/
1616
[*-master]: ${prefix}/${version}/fundamentals/class-mapping/ -> ${base}/${version}/fundamentals/serialization/class-mapping/
17+
[*-v2.30]: ${prefix}/${version}/upgrade/v2/ -> ${base}/${version}/upgrade/
18+
[*-v2.30]: ${prefix}/${version}/upgrade/v3/ -> ${base}/${version}/upgrade/

source/fundamentals/authentication.txt

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,26 @@ MONGODB-AWS
153153
The ``MONGODB-AWS`` authentication mechanism is available only for
154154
MongoDB deployments on MongoDB Atlas.
155155

156-
The ``MONGODB-AWS`` authentication mechanism uses your Amazon Web Services
157-
Identity and Access Management (AWS IAM) credentials to authenticate your
158-
user. You can either specify your credentials explicitly
159-
or instruct the driver to retrieve them automatically from an external source.
156+
The ``MONGODB-AWS`` authentication mechanism uses Amazon Web Services
157+
Identity and Access Management (AWS IAM) credentials to authenticate a user to MongoDB.
160158

161-
The following sections contain code examples that use the following placeholders:
159+
To use AWS authentication, first perform the following steps:
160+
161+
- Add the `MongoDB.Driver.Authentication.AWS <https://www.nuget.org/packages/MongoDB.Driver.Authentication.AWS>`__
162+
NuGet package to your project.
163+
- Add the following line of code to your application's bootstrap code to register the
164+
AWS authentication provider:
165+
166+
.. code-block:: csharp
167+
:copyable: true
168+
169+
MongoClientSettings.Extensions.AddAWSAuthentication();
170+
171+
After you register the AWS authentication provider, you can either specify the AWS IAM
172+
credentials explicitly or instruct the driver to retrieve them automatically from an
173+
external source. The following sections describe both of these methods.
174+
175+
The code examples in these sections use the following placeholders:
162176

163177
- ``<awsKeyId>`` - value of the AWS access key ID
164178
- ``<awsSecretKey>`` - value of the AWS secret access key

source/upgrade/v3.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ Version 3.0 Breaking Changes
6666
provides a replacement for a deprecated class, method, or property, the compiler
6767
messages in v{+last-version-2-number+} will display it.
6868

69+
- The methods, properties, and constructors in the ``MongoDB.Bson`` namespace that were
70+
deprecated in previous versions of the driver have been removed. If the driver
71+
provides a replacement for a deprecated method, property, or constructor, the compiler
72+
messages in v{+last-version-2-number+} will display it.
73+
6974
- The driver drops support for the
7075
``MONGODB-CR`` authentication mechanism. To learn more about
7176
configuring authentication in the {+driver-short+}, see
@@ -145,6 +150,11 @@ Version 3.0 Breaking Changes
145150
- The ``MongoClient`` constructor accepts only one ``Credential`` object instead of an
146151
array.
147152

153+
- To use Amazon Web Services (AWS) authentication, you must add the
154+
``MongoDB.Driver.Authentication.AWS`` package to your project and register the
155+
authentication provider in your application's bootstrap code. To learn more about
156+
using AWS authentication with the {+driver-short+}, see :ref:`csharp-mongodb-aws`.
157+
148158
- If you try to serialize or deserialize a floating-point
149159
``Infinity`` or ``NaN`` value to an integral representation, the driver throws an
150160
``OverflowException``. To learn more about floating-point ``Infinity`` and ``NaN``

0 commit comments

Comments
 (0)