Skip to content

Commit 07c3f77

Browse files
norareidyalcaeusrustagir
committed
PHP Comprehensive Coverage (mongodb#282)
* Add redirects workflow * DOCSP-47058: Shift TOC (mongodb#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (mongodb#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (mongodb#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (mongodb#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (mongodb#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (mongodb#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (mongodb#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (mongodb#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (mongodb#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (mongodb#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (mongodb#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (mongodb#274) * DOCSP-50753: agg tutorial link (mongodb#275) * DOCSP-47063: Logging (mongodb#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (mongodb#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (mongodb#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (mongodb#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (mongodb#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (mongodb#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <andreas.braun@mongodb.com> Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> (cherry picked from commit 70a7512) (cherry picked from commit f11a732)
1 parent 95f0570 commit 07c3f77

File tree

138 files changed

+4087
-2255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+4087
-2255
lines changed

‎.github/actions/setup/action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ runs:
2121
with:
2222
php-version: ${{ inputs.php-version }}
2323
extensions: "mongodb-${{ inputs.driver-version }}"
24-
key: "extcache-v1"
24+
key: "extcache-${{ inputs.driver-version }}"
2525

2626
- name: Cache extensions
2727
uses: actions/cache@v4

‎.github/workflows/add-redirects.yml‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
name: Verify Redirects
2+
3+
on:
4+
pull_request_target:
5+
6+
jobs:
7+
verify-redirects:
8+
name: Verifying Redirects
9+
runs-on: ubuntu-latest
10+
env:
11+
REDIRECTS_FILE: "pr/config/redirects"
12+
permissions:
13+
pull-requests: write
14+
steps:
15+
- name: Check Out Base Branch
16+
uses: actions/checkout@v4
17+
18+
- name: Checkout PR Head Branch
19+
uses: actions/checkout@v4
20+
with:
21+
token: ${{ secrets.GITHUB_TOKEN }}
22+
ref: ${{ github.event.pull_request.head.ref }}
23+
repository: ${{ github.event.pull_request.head.repo.full_name }}
24+
path: pr
25+
26+
- name: Get Changed Files
27+
id: changed-files
28+
uses: tj-actions/changed-files@c65cd883420fd2eb864698a825fc4162dd94482c
29+
with:
30+
include_all_old_new_renamed_files: true
31+
32+
- name: Find Missing Redirects for Renamed Files
33+
id: renamed-files
34+
if: steps.changed-files.outputs.renamed_files_count > 0
35+
env:
36+
RENAMED_FILES: ${{ steps.changed-files.outputs.all_old_new_renamed_files }}
37+
run: |
38+
renamed_redirects=""
39+
40+
for file in $RENAMED_FILES; do
41+
42+
# only run for .txt files
43+
if [[ ! "$file" == *.txt ]]; then
44+
continue
45+
fi
46+
47+
# format old and new URLs
48+
old=$(echo "$file" | cut -d',' -f1)
49+
old="${old#source}"
50+
old="${old%.txt}"
51+
new=$(echo "$file" | cut -d',' -f2)
52+
new="${new#source}"
53+
new="${new%.txt}"
54+
55+
redirect='${prefix}/${version}'"$old"'/ -> ${base}/${version}'"$new"'/'
56+
57+
# if redirect not already in file, add to string to add to PR description
58+
if ! grep -q "$redirect" $REDIRECTS_FILE; then
59+
renamed_redirects+="<li>[&lt;v&gt;-*]: $redirect</li>"
60+
fi
61+
done
62+
63+
echo "redirects=${renamed_redirects}" >> "$GITHUB_OUTPUT"
64+
65+
- name: Find Missing Redirects for Deleted Files
66+
id: deleted-files
67+
if: steps.changed-files.outputs.deleted_files_count > 0
68+
env:
69+
DELETED_FILES: ${{ steps.changed-files.outputs.deleted_files }}
70+
run: |
71+
deleted_redirects=""
72+
73+
for file in $DELETED_FILES; do
74+
75+
# only run for .txt files
76+
if [[ ! "$file" == *.txt ]]; then
77+
continue
78+
fi
79+
80+
# format old URL
81+
old=$(echo "$file" | cut -d',' -f1)
82+
old="${old#source}"
83+
old="${old%.txt}"
84+
85+
redirect='${prefix}/${version}'"$old"'/ -> ${base}/${version}/'
86+
87+
# escape special characters before searching for string
88+
escaped_redirect=$(printf '%s\n' "$redirect" | sed 's/[[*${}|\\]/\\&/g')
89+
90+
# if redirect not already in file, add to string to add to PR description
91+
if ! grep -qE "${escaped_redirect}$" $REDIRECTS_FILE; then
92+
deleted_redirects+="<li>[&lt;v&gt;-*]: $redirect</li>"
93+
fi
94+
done
95+
96+
echo "redirects=${deleted_redirects}" >> "$GITHUB_OUTPUT"
97+
98+
- name: Build Redirect HTML
99+
id: build-redirect-html
100+
env:
101+
RENAMED_REDIRECTS: ${{ steps.renamed-files.outputs.redirects }}
102+
DELETED_REDIRECTS: ${{ steps.deleted-files.outputs.redirects }}
103+
run: |
104+
redirect_html=''
105+
combined_redirects="${RENAMED_REDIRECTS}${DELETED_REDIRECTS}"
106+
107+
if [ -n "$combined_redirects" ]; then
108+
redirect_html="<h3>Suggested redirects for moved, renamed, and deleted files:</h3><p><em>Replace &lt;v&gt; with the earliest backport target version</p></em>$combined_redirects"
109+
fi
110+
111+
echo "redirect_html=${redirect_html}" >> "$GITHUB_OUTPUT"
112+
113+
- name: Update PR Description
114+
uses: MongoCaleb/pr-description-action@4bdfe35b98f64532b419ad20b350a92546cd3aa1
115+
with:
116+
regex: "- \\[( |x)\\] Did you add redirects\\?.*"
117+
appendContentOnMatchOnly: false
118+
regexFlags: is
119+
content: "- [ ] Did you add redirects?\n ${{ steps.build-redirect-html.outputs.redirect_html }}"
120+
token: ${{ secrets.GITHUB_TOKEN }}
121+
122+
- name: Check for duplicates in redirects file
123+
run: |
124+
if [[ -f "$REDIRECTS_FILE" ]]; then
125+
duplicates=$(sort "$REDIRECTS_FILE" | uniq -d)
126+
if [[ -n "$duplicates" ]]; then
127+
echo "Duplicate lines found in $REDIRECTS_FILE:"
128+
echo "$duplicates"
129+
exit 1 # error
130+
fi
131+
else
132+
"Redirects file doesn't exist. Skipping duplicate check."
133+
fi

‎.github/workflows/coding-standards.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ on:
55
paths:
66
- "source/**/*.php"
77
- ".github/workflows/*.yml"
8+
- ".github/actions/**"
89

910
env:
1011
PHP_VERSION: "8.2"

‎.github/workflows/static-analysis.yml‎

Lines changed: 0 additions & 56 deletions
This file was deleted.

‎composer/composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
"dealerdirect/phpcodesniffer-composer-installer": true
1616
}
1717
}
18-
}
18+
}

‎config/redirects‎

Lines changed: 52 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ symlink: current -> v1.21
1717
# redirects in standardized docs
1818
[v1.20-*]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/${version}/get-started/download-and-install/
1919
[v1.20-*]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/${version}/connect/
20-
[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring/cluster-monitoring/
20+
[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring-logging/monitoring/
2121
[v1.20-*]: ${prefix}/${version}/tutorial/crud/ -> ${base}/${version}/read/
2222
[v1.20-*]: ${prefix}/${version}/tutorial/codecs/ -> ${base}/${version}/data-formats/codecs/
2323
[v1.20-*]: ${prefix}/${version}/tutorial/collation/ -> ${base}/${version}/
@@ -35,19 +35,54 @@ symlink: current -> v1.21
3535

3636
# redirects in old docs
3737
# note: this mapping does not account for all of the new pages
38-
[*-v1.19]: ${prefix}/${version}/get-started/download-and-install/ -> ${base}/${version}/tutorial/install-php-library/
39-
[*-v1.19]: ${prefix}/${version}/connect/ -> ${base}/${version}/tutorial/connecting/
40-
[*-v1.19]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/tutorial/server-selection/
41-
[*-v1.19]: ${prefix}/${version}/read/ -> ${base}/${version}/tutorial/crud/
42-
[*-v1.19]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/tutorial/codecs/
43-
[*-v1.19]: ${prefix}/${version}/run-command/ -> ${base}/${version}/tutorial/commands/
44-
[*-v1.19]: ${prefix}/${version}/data-formats/custom-types/ -> ${base}/${version}/tutorial/custom-types/
45-
[*-v1.19]: ${prefix}/${version}/data-formats/decimal128/ -> ${base}/${version}/tutorial/decimal128/
46-
[*-v1.19]: ${prefix}/${version}/security/in-use-encryption/ -> ${base}/${version}/tutorial/encryption/
47-
[*-v1.19]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/tutorial/gridfs/
48-
[*-v1.19]: ${prefix}/${version}/indexes/ -> ${base}/${version}/tutorial/indexes/
49-
[*-v1.19]: ${prefix}/${version}/read/cursor/ -> ${base}/${version}/tutorial/tailable-cursor/
50-
[*-v1.19]: ${prefix}/${version}/data-formats/modeling-bson-data/ -> ${base}/${version}/tutorial/modeling-bson-data/
51-
[*-v1.19]: ${prefix}/${version}/stable-api/ -> ${base}/${version}/tutorial/stable-api/
52-
[*-v1.19]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/
53-
[*-v1.19]: ${prefix}/${version}/aws-lambda/ -> ${base}/${version}/tutorial/aws-lambda/
38+
[*-v1.19]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/v1.x/get-started/
39+
[*-v1.19]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/v1.x/connect/
40+
[*-v1.19]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/v1.x/monitoring-logging/monitoring/
41+
[*-v1.19]: ${prefix}/${version}/tutorial/crud/ -> ${base}/v1.x/read/
42+
[*-v1.19]: ${prefix}/${version}/tutorial/codecs/ -> ${base}/v1.x/data-formats/codecs/
43+
[*-v1.19]: ${prefix}/${version}/tutorial/collation/ -> ${base}/v1.x/
44+
[*-v1.19]: ${prefix}/${version}/tutorial/commands/ -> ${base}/v1.x/run-command/
45+
[*-v1.19]: ${prefix}/${version}/tutorial/custom-types/ -> ${base}/v1.x/data-formats/custom-types/
46+
[*-v1.19]: ${prefix}/${version}/tutorial/decimal128/ -> ${base}/v1.x/data-formats/decimal128/
47+
[*-v1.19]: ${prefix}/${version}/tutorial/encryption/ -> ${base}/v1.x/security/in-use-encryption/
48+
[*-v1.19]: ${prefix}/${version}/tutorial/gridfs/ -> ${base}/v1.x/write/gridfs/
49+
[*-v1.19]: ${prefix}/${version}/tutorial/indexes/ -> ${base}/v1.x/indexes/
50+
[*-v1.19]: ${prefix}/${version}/tutorial/tailable-cursor/ -> ${base}/v1.x/read/cursor/
51+
[*-v1.19]: ${prefix}/${version}/tutorial/example-data/ -> ${base}/v1.x/
52+
[*-v1.19]: ${prefix}/${version}/tutorial/modeling-bson-data/ -> ${base}/v1.x/data-formats/modeling-bson-data/
53+
[*-v1.19]: ${prefix}/${version}/tutorial/stable-api/ -> ${base}/v1.x/stable-api/
54+
[*-v1.19]: ${prefix}/${version}/tutorial/aws-lambda/ -> ${base}/v1.x/aws-lambda/
55+
56+
# comprehensive coverage redirects
57+
[*-master]: ${prefix}/${version}/aggregation/atlas-search/ -> ${base}/${version}/atlas-search/
58+
[*-master]: ${prefix}/${version}/aws-lambda/ -> ${base}/${version}/connect/aws-lambda/
59+
[*-master]: ${prefix}/${version}/connect/stable-api/ -> ${base}/${version}/connect/connection-options/stable-api/
60+
[*-master]: ${prefix}/${version}/builders/ -> ${base}/${version}/crud/builders/
61+
[*-master]: ${prefix}/${version}/write/bulk-write/ -> ${base}/${version}/crud/bulk-write/
62+
[*-master]: ${prefix}/${version}/write/delete/ -> ${base}/${version}/crud/delete/
63+
[*-master]: ${prefix}/${version}/write/gridfs/ -> ${base}/${version}/crud/gridfs/
64+
[*-master]: ${prefix}/${version}/write/insert/ -> ${base}/${version}/crud/insert/
65+
[*-master]: ${prefix}/${version}/read/count/ -> ${base}/${version}/crud/query/count/
66+
[*-master]: ${prefix}/${version}/read/cursor/ -> ${base}/${version}/crud/query/cursor/
67+
[*-master]: ${prefix}/${version}/read/distinct/ -> ${base}/${version}/crud/query/distinct/
68+
[*-master]: ${prefix}/${version}/read/project/ -> ${base}/${version}/crud/query/project/
69+
[*-master]: ${prefix}/${version}/read/retrieve/ -> ${base}/${version}/crud/query/retrieve/
70+
[*-master]: ${prefix}/${version}/read/specify-a-query/ -> ${base}/${version}/crud/query/specify-a-query/
71+
[*-master]: ${prefix}/${version}/read/specify-documents-to-return/ -> ${base}/${version}/crud/query/specify-documents-to-return/
72+
[*-master]: ${prefix}/${version}/read-write-pref/ -> ${base}/${version}/crud/read-write-pref/
73+
[*-master]: ${prefix}/${version}/write/replace/ -> ${base}/${version}/crud/replace/
74+
[*-master]: ${prefix}/${version}/write/transaction/ -> ${base}/${version}/crud/transaction/
75+
[*-master]: ${prefix}/${version}/write/update/ -> ${base}/${version}/crud/update/
76+
[*-master]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/data-formats/custom-types/codecs/
77+
[*-master]: ${prefix}/${version}/databases-collections/time-series/ -> ${base}/${version}/data-formats/time-series/
78+
[*-master]: ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/monitoring-logging/change-streams/
79+
[*-master]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/monitoring/
80+
[*-master]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/references/compatibility/
81+
[*-master]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/references/release-notes/
82+
[*-master]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/references/upgrade/
83+
[*-master]: ${prefix}/${version}/connect/tls/ -> ${base}/${version}/security/tls/
84+
[*-master]: ${prefix}/${version}/aggregation/vector-search/ -> ${base}/${version}/vector-search/
85+
[*-master]: ${prefix}/${version}/monitoring/ -> ${base}/${version}/monitoring-logging/
86+
[*-master]: ${prefix}/${version}/read/ -> ${base}/${version}/crud/
87+
[*-master]: ${prefix}/${version}/write/ -> ${base}/${version}/crud/
88+
[*-master]: ${prefix}/${version}/faq/ -> ${base}/${version}/

0 commit comments

Comments
 (0)