Skip to content

Commit ec39fff

Browse files
authored
fix: post-0.1.0 packaging, dependency, and release-workflow cleanup (#5)
* fix: post-0.1.0 packaging, dependency, and release-workflow cleanup Bundles fixes and improvements discovered after the 0.1.0 release. Packaging: - Scope each package's sdist to its own source (no monorepo tarball; no bleed of tests/, demo/, docs/ between adapter sdists). - Ship Apache-2.0 LICENSE in adapter wheels. - Derive __version__ from installed package metadata across all three packages (no more hardcoded, drift-prone constant). - Align adapter pyproject.toml metadata with the SDK (classifiers, Repository / Changelog URLs). Dependencies: - Tighten authplane-fastmcp floor to fastmcp>=3.2,<4 (was >=2.0, which could resolve to fastmcp 2.x and crash at import — the adapter uses the v3 auth surface). Docs: - Use absolute GitHub URL for the User Guide link so it resolves on PyPI. - Correct the fastmcp demo port (8080, not 8090). CI / release workflow: - Clone the shared conformance catalog into $RUNNER_TEMP to keep it out of the working tree we tag and publish. - Mint a short-lived release-bot App token for the atomic tag/branch push step in release.yml (default GITHUB_TOKEN is rejected by the v* tag ruleset). - Fail fast in release.yml when release-bot secrets are missing. * docs(authplane-mcp): enforce scope in README quickstart example The Quickstart used a bare @mcp.tool() while passing scopes=[...] to authplane_mcp_auth, implying enforcement that never happened.
1 parent 0d2367d commit ec39fff

18 files changed

Lines changed: 522 additions & 31 deletions

File tree

.github/workflows/ci.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ jobs:
2222
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
2323

2424
# AuthPlane/conformance is the public sibling repo carrying the shared
25-
# oauth-sdk-conformance-catalog.yaml. Without it, conformance-tests
26-
# cannot run.
27-
- name: Check out shared conformance catalog
25+
# oauth-sdk-conformance-catalog.yaml. Cloned to $RUNNER_TEMP — outside
26+
# $GITHUB_WORKSPACE — so the catalog stays out of the working tree,
27+
# matching release.yml's invariant. Plain git clone is enough:
28+
# actions/checkout disallows paths outside the workspace, and we don't
29+
# need its auth/persist-credentials features for a public read-only repo.
30+
- name: Clone shared conformance catalog (out of tree)
2831
if: matrix.package == 'root'
29-
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
30-
with:
31-
repository: AuthPlane/conformance
32-
path: conformance
33-
fetch-depth: 1
32+
run: |
33+
git clone --depth 1 https://github.com/AuthPlane/conformance.git "$RUNNER_TEMP/conformance"
3434
3535
- name: Setup Python
3636
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
@@ -74,7 +74,7 @@ jobs:
7474

7575
- name: Test and coverage
7676
env:
77-
CONFORMANCE_CATALOG_PATH: ${{ github.workspace }}/conformance/oauth-sdk-conformance-catalog.yaml
77+
CONFORMANCE_CATALOG_PATH: ${{ runner.temp }}/conformance/oauth-sdk-conformance-catalog.yaml
7878
run: |
7979
if [ "${{ matrix.package }}" = "root" ]; then
8080
coverage run -m pytest tests conformance-tests && coverage report

.github/workflows/release.yml

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,21 +53,46 @@ jobs:
5353
fi
5454
echo "Dispatched from $ref"
5555
56+
# Fail fast if the AuthPlane Release Bot App secrets aren't available
57+
# (e.g. a fork or unconfigured clone). The token-mint step would
58+
# otherwise fail with a generic actions/create-github-app-token error.
59+
- name: Refuse if Release Bot secrets are missing
60+
env:
61+
APP_ID: ${{ secrets.RELEASE_BOT_APP_ID }}
62+
PRIVATE_KEY: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }}
63+
run: |
64+
if [[ -z "$APP_ID" || -z "$PRIVATE_KEY" ]]; then
65+
echo "::error::Release Bot App secrets (RELEASE_BOT_APP_ID / RELEASE_BOT_PRIVATE_KEY) are unavailable in this run. They live as AuthPlane org secrets scoped to the OSS release repo; forks and unconfigured clones cannot run release.yml end-to-end and must follow the manual tagging fallback."
66+
exit 1
67+
fi
68+
69+
# Tag/branch rulesets reject GHA bot pushes for v* tags. Mint a
70+
# short-lived installation token for the AuthPlane Release Bot App
71+
# (bypass actor on the ruleset) and pass it to checkout so the
72+
# atomic push and source-branch delete use the App's identity.
73+
- name: Mint release-bot token
74+
id: app_token
75+
uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
76+
with:
77+
app-id: ${{ secrets.RELEASE_BOT_APP_ID }}
78+
private-key: ${{ secrets.RELEASE_BOT_PRIVATE_KEY }}
79+
5680
- name: Check out repo with full history and all tags
5781
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
5882
with:
5983
fetch-depth: 0
6084
ref: ${{ github.ref }}
85+
token: ${{ steps.app_token.outputs.token }}
6186

6287
# AuthPlane/conformance is the public sibling repo carrying the shared
63-
# oauth-sdk-conformance-catalog.yaml. Without it, conformance-tests
64-
# cannot run.
65-
- name: Check out shared conformance catalog
66-
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
67-
with:
68-
repository: AuthPlane/conformance
69-
path: conformance
70-
fetch-depth: 1
88+
# oauth-sdk-conformance-catalog.yaml. Cloned to $RUNNER_TEMP — outside
89+
# $GITHUB_WORKSPACE — so the catalog checkout never pollutes the working
90+
# tree of the commit we tag and publish. Plain git clone is enough:
91+
# actions/checkout disallows paths outside the workspace, and we don't
92+
# need its auth/persist-credentials features for a public read-only repo.
93+
- name: Clone shared conformance catalog (out of tree)
94+
run: |
95+
git clone --depth 1 https://github.com/AuthPlane/conformance.git "$RUNNER_TEMP/conformance"
7196
7297
- name: Set up Python 3.11
7398
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
@@ -148,7 +173,7 @@ jobs:
148173
# below, as part of the single release commit.
149174
- name: Install packages and run tests
150175
env:
151-
CONFORMANCE_CATALOG_PATH: ${{ github.workspace }}/conformance/oauth-sdk-conformance-catalog.yaml
176+
CONFORMANCE_CATALOG_PATH: ${{ runner.temp }}/conformance/oauth-sdk-conformance-catalog.yaml
152177
run: |
153178
pip install -e ".[dev]"
154179
pip install -e "./authplane-mcp[dev]"
@@ -231,6 +256,9 @@ jobs:
231256
echo "See CHANGELOG.md for details." >> /tmp/release-notes.md
232257
fi
233258
259+
# GitHub Release creation goes through the API, not git push, so the
260+
# default GITHUB_TOKEN is sufficient — the Release Bot App token is
261+
# only needed for the tag/branch push and source-branch delete above.
234262
- name: Create GitHub Release
235263
if: ${{ !inputs.dryRun }}
236264
env:

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Fixed
11+
- Packaging issues discovered after the first release.
12+
- Documentation links and demo references.
13+
- `authplane-fastmcp` dependency range now correctly requires `fastmcp>=3.2,<4` (was `>=2.0`, which could resolve to a version the adapter can't import).
14+
15+
### Changed
16+
- CI and release workflow improvements from first-release learnings.
17+
1018
## [0.1.0] - 2026-05-11
1119

1220
- Initial release.

authplane-fastmcp/LICENSE

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to the Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by the Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding any notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
Copyright 2025 AuthPlane
180+
181+
Licensed under the Apache License, Version 2.0 (the "License");
182+
you may not use this file except in compliance with the License.
183+
You may obtain a copy of the License at
184+
185+
http://www.apache.org/licenses/LICENSE-2.0
186+
187+
Unless required by applicable law or agreed to in writing, software
188+
distributed under the License is distributed on an "AS IS" BASIS,
189+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190+
See the License for the specific language governing permissions and
191+
limitations under the License.

authplane-fastmcp/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ asyncio.run(main())
4848

4949
## Documentation
5050

51-
PRM behavior, dev mode, revocation checking, manual setup, scope enforcement semantics, claim access, the full `authplane_auth` / `AuthplaneTokenVerifier` API, and error handling: **[User Guide](docs/user-guide.md)**.
51+
PRM behavior, dev mode, revocation checking, manual setup, scope enforcement semantics, claim access, the full `authplane_auth` / `AuthplaneTokenVerifier` API, and error handling: **[User Guide](https://github.com/AuthPlane/python-sdk/blob/main/authplane-fastmcp/docs/user-guide.md)**.

authplane-fastmcp/authplane_fastmcp/__init__.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@
88
exports only the adapter-owned glue.
99
"""
1010

11-
__version__ = "0.1.0"
11+
from importlib.metadata import PackageNotFoundError as _PackageNotFoundError
12+
from importlib.metadata import version as _version
13+
14+
try:
15+
__version__ = _version("authplane-fastmcp")
16+
except _PackageNotFoundError: # pragma: no cover - source tree without an install
17+
__version__ = "0.0.0+unknown"
1218

1319
from .auth import AuthplaneAuthResult, authplane_auth
1420
from .url_elicitation import to_url_elicitation_required_error

authplane-fastmcp/authplane_fastmcp/auth.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ async def authplane_auth(
265265
)
266266

267267
# Wrap in AuthplaneTokenVerifier
268-
# Note: FastMCP 3.0.0 uses token_verifier.base_url for PRM generation if provided
268+
# Note: FastMCP uses token_verifier.base_url for PRM generation if provided
269269
token_verifier = AuthplaneTokenVerifier(verifier, base_url=base_url)
270270

271271
# Wrap in RemoteAuthProvider to get PRM routes

authplane-fastmcp/demo/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ cd authplane-fastmcp
2929
./demo/run.sh
3030
```
3131

32-
`run.sh` creates a virtualenv, installs dependencies, and starts the server on port `8090`. All demo credentials are pre-configured — no additional setup needed.
32+
`run.sh` creates a virtualenv, installs dependencies, and starts the server on port `8080`. All demo credentials are pre-configured — no additional setup needed.
3333

3434
## How it works
3535

3636
Note that FastMCP filters tools if the scope is not available.
3737

3838
```
39-
MCP Client ──Bearer JWT──► mcpserver.py (port 8090)
39+
MCP Client ──Bearer JWT──► mcpserver.py (port 8080)
4040
4141
├─ authplane_auth()
4242
│ • Discovers JWKS from ISSUER_URL

authplane-fastmcp/demo/mcpserver.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ def multiply(a: float, b: float) -> float:
5959
return a * b
6060

6161
# NOTE: a ``consent_demo`` tool that exercises the URL elicitation path
62-
# was intentionally omitted from this demo. fastmcp 3.2.4 does not
62+
# was intentionally omitted from this demo. fastmcp 3.2 does not
6363
# propagate ``UrlElicitationRequiredError`` (an ``McpError`` subclass)
6464
# raised inside a tool handler — its tool-call dispatch catches only
6565
# ``FastMCPError`` and wraps everything else as an ``isError: true``

0 commit comments

Comments
 (0)