Skip to content

Commit 73208b6

Browse files
authored
chore: fix markdown link checker (#1400)
1 parent 42afaa9 commit 73208b6

File tree

19 files changed

+114
-103
lines changed

19 files changed

+114
-103
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ body:
3131
label: Current Behavior
3232
description: |
3333
What actually happened?
34-
34+
3535
Please include full errors, uncaught exceptions, stack traces, and relevant logs.
36-
37-
To see how to enable driver logging see https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#logging.
36+
37+
To see how to enable driver logging see https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#logging.
3838
validations:
3939
required: true
4040
- type: textarea
@@ -44,7 +44,7 @@ body:
4444
description: |
4545
Provide a self-contained, concise snippet of code that can be used to reproduce the issue.
4646
For more complex issues provide a repo with the smallest sample that reproduces the bug.
47-
47+
4848
Avoid including business logic or unrelated code, it makes diagnosis more difficult.
4949
The code sample should be an SSCCE. See http://sscce.org/ for details. In short, please provide a code sample that we can copy/paste, run and reproduce.
5050
validations:

.github/workflows/main.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ jobs:
2020
markdown-link-check:
2121
runs-on: ubuntu-latest
2222
steps:
23-
- uses: actions/checkout@master
24-
- uses: gaurav-nelson/github-action-markdown-link-check@v1
23+
- uses: actions/checkout@v4
24+
- uses: tcort/github-action-markdown-link-check@v1
2525
with:
2626
use-quiet-mode: 'yes'
2727
folder-path: 'docs'
28+
config-file: '.github/workflows/mlc_config.json'
2829
build-driver:
2930
name: 'Run non-container integration tests'
3031
concurrency: Non-IntegrationTests

.github/workflows/mlc_config.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"retryOn429": true,
3+
"retryCount": 5,
4+
"replacementPatterns": [
5+
{
6+
"pattern": "^#",
7+
"replacement": "{{BASEURL}}#"
8+
}
9+
]
10+
}

CHANGELOG.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
7272

7373
### :magic_wand: Added
7474
- Custom Endpoint Plugin. See [UsingTheCustomEndpointPlugin.md](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheCustomEndpointPlugin.md).
75-
- Allow driver failover when network exceptions occur in the connect pipeline for the failover 2 plugin ([PR #1133](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/1133) and [PR #1143](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/1143)).
75+
- Allow driver failover when network exceptions occur in the connect pipeline for the failover 2 plugin ([PR #1133](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1133) and [PR #1143](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1143)).
7676

7777
### :bug: Fixed
7878
- Use the cluster URL as the default cluster ID ([PR #1131](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1131)).
@@ -132,54 +132,54 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
132132
## [2.3.6] - 2024-05-01
133133

134134
### :magic_wand: Added
135-
- Okta Authentication Support. See [UsingTheOktaAuthPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheOktaAuthPlugin.md).
135+
- Okta Authentication Support. See [UsingTheOktaAuthPlugin](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheOktaAuthPlugin.md).
136136
- Documentation:
137-
- Aurora Initial Connection Strategy Plugin. See [UsingTheAuroraInitialConnectionStrategyPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md)
138-
- Additional instructions to enable logging for Spring and Spring Boot. See [Logging](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#logging).
137+
- Aurora Initial Connection Strategy Plugin. See [UsingTheAuroraInitialConnectionStrategyPlugin](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheAuroraInitialConnectionStrategyPlugin.md)
138+
- Additional instructions to enable logging for Spring and Spring Boot. See [Logging](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#logging).
139139

140140
### :bug: Fixed
141141
- Connection identification and tracking in the host list provider (PR #943)[https://github.com/aws/aws-advanced-jdbc-wrapper/pull/943].
142-
- Green node endpoint replacement, allowing the AWS JDBC Driver to detect and connect to green nodes after Blue/Green switchover (PR# 948)(https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/948). Addresses [issue #678](https://github.com/awslabs/aws-advanced-jdbc-wrapper/issues/678).
143-
- MariaDB Pool Datasource support. Addresses [issue #957](https://github.com/awslabs/aws-advanced-jdbc-wrapper/issues/957).
142+
- Green node endpoint replacement, allowing the AWS JDBC Driver to detect and connect to green nodes after Blue/Green switchover (PR# 948)(https://github.com/aws/aws-advanced-jdbc-wrapper/pull/948). Addresses [issue #678](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/678).
143+
- MariaDB Pool Datasource support. Addresses [issue #957](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/957).
144144

145145
### :crab: Changed
146-
- Log level of `Failover.startWriterFailover` and `Failover.establishedConnection` from `fine` to `info` for better visibility of failover-related logs ([Issue #890](https://github.com/awslabs/aws-advanced-jdbc-wrapper/issues/890)).
147-
- Telemetry's connection property documentation. See [Telemetry](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/Telemetry.md).
146+
- Log level of `Failover.startWriterFailover` and `Failover.establishedConnection` from `fine` to `info` for better visibility of failover-related logs ([Issue #890](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/890)).
147+
- Telemetry's connection property documentation. See [Telemetry](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/Telemetry.md).
148148

149149
## [2.3.5] - 2024-03-14
150150

151151
### :magic_wand: Added
152-
- Sample code configuring the AWS JDBC Driver with DBCP ([PR #930](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/930)).
152+
- Sample code configuring the AWS JDBC Driver with DBCP ([PR #930](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/930)).
153153

154154
### :crab: Changed
155-
- Fix issue with deadlock while using prepared transactions and PostgreSQL Explicit Locking ([PR #918](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/918)).
156-
- Removed `ConnectionStringHostListProvider#identifyConnection` since it is not used ([PR #920](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/920)).
155+
- Fix issue with deadlock while using prepared transactions and PostgreSQL Explicit Locking ([PR #918](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/918)).
156+
- Removed `ConnectionStringHostListProvider#identifyConnection` since it is not used ([PR #920](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/920)).
157157

158158
## [2.3.4] - 2024-03-01
159159
### :magic_wand: Added
160160
- Documentation:
161-
- Bundled Uber Jar for Federated Authentication. See [UsingTheFederatedAuthPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar).
162-
- Using the Read Write Splitting Plugin's internal connection pool with Spring applications. See [UsingTheReadWriteSplittingPlugin](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#internal-connection-pools).
163-
- Spring Framework application code examples with load balanced access to database cluster reader instances ([PR #852](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/852)).
164-
- New configuration preset `SF_` optimized for Spring Framework applications ([PR #852](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/852)).
165-
- Lightweight alternative for IAM token generator that requires fewer dependencies ([PR #867](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/867)).
161+
- Bundled Uber Jar for Federated Authentication. See [UsingTheFederatedAuthPlugin](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar).
162+
- Using the Read Write Splitting Plugin's internal connection pool with Spring applications. See [UsingTheReadWriteSplittingPlugin](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#internal-connection-pools).
163+
- Spring Framework application code examples with load balanced access to database cluster reader instances ([PR #852](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/852)).
164+
- New configuration preset `SF_` optimized for Spring Framework applications ([PR #852](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/852)).
165+
- Lightweight alternative for IAM token generator that requires fewer dependencies ([PR #867](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/867)).
166166

167167
### :bug: Fixed
168-
- Fixes to session state transfer ([PR #852](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/852)).
169-
- Enhanced Host Monitoring Plugin (EFM) v2 plugin to use `ConcurrentHashMap` instead of `HashMap` to avoid `ConcurrentModificationException` ([Issue #855](https://github.com/awslabs/aws-advanced-jdbc-wrapper/issues/855)).
170-
- Move lock location and skip executing `Statement.getConnection` when running `Statement.cancel` to fix `Statement.cancel` for MySQL ([PR #851](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/851))
171-
- Remove Telemetry trace associated with a Monitor thread because traces for long-running tasks is an anti-pattern ([PR #875](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/875)).
168+
- Fixes to session state transfer ([PR #852](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/852)).
169+
- Enhanced Host Monitoring Plugin (EFM) v2 plugin to use `ConcurrentHashMap` instead of `HashMap` to avoid `ConcurrentModificationException` ([Issue #855](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/855)).
170+
- Move lock location and skip executing `Statement.getConnection` when running `Statement.cancel` to fix `Statement.cancel` for MySQL ([PR #851](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/851))
171+
- Remove Telemetry trace associated with a Monitor thread because traces for long-running tasks is an anti-pattern ([PR #875](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/875)).
172172

173173
### :crab: Changed
174-
- HostSelector implementations to take into account HostAvailability ([PR #856](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/856)).
175-
- Reduced the number of Regular Expression checks with `Matcher.find` to improve performance ([PR #854](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/854)).
176-
- HostSpec class to not use a default lastUpdateTime and instead use null ([PR 877](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/877)).
177-
- Moved Reader Selection Strategies out of the `UsingTheReadWriteSplittingPlugin` doc and into its own page. See [ReaderSelectionStrategies](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/ReaderSelectionStrategies.md).
174+
- HostSelector implementations to take into account HostAvailability ([PR #856](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/856)).
175+
- Reduced the number of Regular Expression checks with `Matcher.find` to improve performance ([PR #854](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/854)).
176+
- HostSpec class to not use a default lastUpdateTime and instead use null ([PR 877](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/877)).
177+
- Moved Reader Selection Strategies out of the `UsingTheReadWriteSplittingPlugin` doc and into its own page. See [ReaderSelectionStrategies](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/ReaderSelectionStrategies.md).
178178

179179
## [2.3.3] - 2024-01-23
180180
### :magic_wand: Added
181181
- Documentation:
182-
- [Read Write Splitting Plugin Limitations with Spring Boot/Framework](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#limitations-when-using-spring-bootframework).
182+
- [Read Write Splitting Plugin Limitations with Spring Boot/Framework](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheReadWriteSplittingPlugin.md#limitations-when-using-spring-bootframework).
183183
- AWS Profile configuration parameter. See [README](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/README.md#properties), [UsingTheJDBCDriver](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#aws-advanced-jdbc-driver-parameters), and [AwsCredentialsConfiguration](https://github.com/awslabs/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/custom-configuration/AwsCredentialsConfiguration.md).
184184
- Example code for ReadWriteSplitting Plugin ([PR #765](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/765)).
185185
- Enabling AWS Profile for IAM and AWS Secrets Manager authentication plugins ([PR #786](https://github.com/awslabs/aws-advanced-jdbc-wrapper/pull/786)).

0 commit comments

Comments
 (0)