Releases: connected-web/template-api
v1.0.2
Summary
v1.0.2 improves consumer-facing deployment verification by asserting stack outputs after deployment.
What Changed
- Added post-deployment CI validation step in
Check PR:- Calls
cweb deployments describe --item-id ... - Reads
deployment.outputsfrom Management API - Fails CI if expected output values drift
- Calls
- Validated outputs include:
ApiBaseUrlOpenAPISpecEndpointStatusEndpointApiGatewayEndpoint(debug, non-empty)
Why
Management/UI consumers should focus on custom-domain endpoints, not raw execute-api URLs. This release adds an explicit automated guardrail to enforce that contract.
Validation
- PR workflow passed with output assertions enabled.
- Deployment output payload confirmed expected values for
template-api.dev.connected-web.servicesURLs.
Notes
This release is intentionally incremental on top of v1.0.1: no deployment model change, only stronger post-deploy correctness checks.
v1.0.1
Summary
v1.0.1 is the migration release that moves template-api to Connected Web package-based deployment via Management API.
What Changed
- Adopted package deployment workflows (
cweb package pack/publish/deploy) for CI and release paths. - Switched CI auth to GitHub Environment machine credentials:
CWEB_CLIENT_IDCWEB_CLIENT_SECRET
- Added and standardized package workflows:
Check PRpackage deploy path in devPackage Pre-releasePackage Release
- Added migration documentation:
MIGRATION.md
- Removed deprecated OIDC validation workflow.
Runtime/Stack Alignment
- Stack supports shared-authorizer deploy-time injection pattern.
- Deployment config is resolved from
cweb configureoutputs in CI.
Validation
Validated through green CI on PR and RC runs, including:
- CDK/unit tests
- package publish/deploy to dev
- post-deployment smoke tests
- API client publish from deployed
/openapi
Notes
This release establishes the baseline package-driven flow and environment bootstrapping conventions for future template consumers.
v1.0.1-rc.4
Pre-release verification run after release/dev routing updates.
v1.0.1-rc.3
Semver/versioning fix for release-triggered API client publish workflow.
v1.0.1-rc.2
Follow-up RC to validate release-mode client publish env/secret resolution.
v1.0.1-rc.1
Release Candidate
This release candidate validates the migration of template-api to package-based deployment through Management API.
Included
cweb package pack/publish/deployworkflow adoption- CI machine-credential auth using GitHub Environments (
CWEB_CLIENT_ID/CWEB_CLIENT_SECRET) - deploy-time shared-authorizer injection contract
- migration guide (
MIGRATION.md) - removal of deprecated OIDC validation workflow
Validation Scope
- PR check flow green on branch
feat/cweb-package-release-flow - dev package deploy + post-deploy smoke + API client publish
1.0.0
What's Changed
- Fix initial API Design by @johnbeech in #1
- Use @connected-web/openapi-rest-api packge by @johnbeech in #2
- Upgrade openapi-rest-api lib to 0.1.4 by @johnbeech in #3
- Update example endpoints to use new structure by @johnbeech in #5
- Update @connected-web/openapi-rest-api to 0.4.0 by @johnbeech in #6
- Add Publish NPM Client workflow and integrate into PR checks by @johnbeech in #7
- Currently using @connected-web/openapi-rest-api to 0.6.4 for header based authorization
New Contributors
- @johnbeech made their first contribution in #1
Full Changelog: https://github.com/connected-web/template-api/commits/1.0.0