Skip to content

docs: pin the install snippets to the released 0.3.0 #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RobertoIskandarani wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −6
Open

docs: pin the install snippets to the released 0.3.0 #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aaed36c
docs: pin the install snippets to the released 0.3.0
RobertoIskandarani Oct 2, 2026
49fd2c4
docs(release): add the install snippets to the stabilize checklist
RobertoIskandarani Oct 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions RELEASE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ On `release/v<X.Y.Z>`:

- Move content from `## [Unreleased]` in `CHANGELOG.md` into a new `## [<X.Y.Z>]` section.
- Land any last-minute fixes (checkstyle, doc updates, etc.).
- Set the install snippets to `<X.Y.Z>`: `core/README.md`, `mcp/README.md`, `spring/README.md` and the three `*/docs/user-guide.md`. No workflow rewrites them, so they go stale otherwise.

> Why `-SNAPSHOT` during stabilization: a developer who runs `mvn install` from a release branch gets a clearly-snapshot artifact in their local Maven cache — Maven treats it as mutable and will re-fetch. If the branch carried the final `X.Y.Z` already, that artifact would be indistinguishable from the eventual Central-published version, and last-minute fixes wouldn't refresh anyone's local cache. `release.yml` strips the suffix and writes `X.Y.Z` in the same commit it tags.

Expand Down
2 changes: 1 addition & 1 deletion core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Framework-agnostic OAuth 2.1 JWT validation and token operations for Java resour
<dependency>
<groupId>ai.authplane.sdk</groupId>
<artifactId>authplane-sdk</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.3.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion core/docs/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The SDK is built around these RFCs:
<dependency>
<groupId>ai.authplane.sdk</groupId>
<artifactId>authplane-sdk</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.3.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Authplane JWT authentication for servers built on the [MCP Java SDK](https://git
<dependency>
<groupId>ai.authplane.sdk</groupId>
<artifactId>authplane-mcp</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.3.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion mcp/docs/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ OAuth 2.1 JWT authentication for servers built on the [MCP Java SDK](https://git
<dependency>
<groupId>ai.authplane.sdk</groupId>
<artifactId>authplane-mcp</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.3.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion spring/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Authplane JWT authentication for [Spring Boot](https://spring.io/projects/spring
<dependency>
<groupId>ai.authplane.sdk</groupId>
<artifactId>authplane-spring</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.3.0</version>
</dependency>

<!-- Required for the Spring Security integration path -->
Expand Down
2 changes: 1 addition & 1 deletion spring/docs/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Add the dependency to your `pom.xml`:
<dependency>
<groupId>ai.authplane.sdk</groupId>
<artifactId>authplane-spring</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>0.3.0</version>
</dependency>
```

Expand Down
Loading