Skip to content
Capell CMS

Deployments

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

Field Value
Composer package capell-app/deployments
Package slug deployments
Product group Capell Operations
Tier premium
Bundle operations
Runtime contexts admin
Capell version ^1.0
Catalogue role extension
Release channel Labs
Source repository capell-app/packages
Source path packages/deployments
Docs source packages/deployments/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Deployments is an Available, Schema-owning Capell package in the Capell Operations product group. It ships as capell-app/deployments and extends these surfaces: admin.

Deployments connects a GitHub, GitLab, or Bitbucket repository and publishes authorized Composer requirement changes through the selected repository policy.

Operators connect and verify the repository, review publication history, and see connection health from the admin page and system health widget.

Evidence: capell.json, routes/oauth.php, src/Services/GitProvider/GitProviderFactory.php, src/Actions/PublishComposerRequirementAction.php, docs/overview.admin.md, docs/screenshots.json, src/Filament/Pages/DeploymentConnectionPage.php, tests/Feature/Filament/DeploymentConnectionPageTest.php.

Status details:

  • Status: Available
  • Tier: premium
  • Bundle: operations
  • Composer package: capell-app/deployments
  • Namespace: Capell\Deployments
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: Provider adapters, OAuth state Actions, and typed publication data keep repository-specific behavior behind a common contract.

For teams: Extension changes can follow a reviewed pull request, merge, or direct commit policy without requiring an operator to use the server shell.

Evidence: src/Contracts/GitProviderContract.php, src/Actions/OAuth/ValidateOAuthStateAction.php, src/Data/ComposerPublicationOperationData.php, tests/Unit/Services/GitProviderFactoryTest.php, docs/admin-guide.md, src/Enums/InstallPolicy.php, src/Actions/AuthorizeComposerPublicationAction.php, tests/Feature/GitOps/PublishComposerRequirementActionTest.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Deployment connection page before a repository is connected Deployment connection page before a repository is connected Deployment connection page with a repository connected Deployment connection page with a repository connected
  • Deployment connection page before a repository is connected (admin, required).
  • Deployment connection page with a repository connected (admin, optional).
  • Deployment publication history (admin, optional).
  • Deployment connection dashboard widget (admin, optional).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\Deployments\Providers\DeploymentsServiceProvider.
  • Config files: packages/deployments/config/capell-deployments.php.
  • Migrations: packages/deployments/database/migrations/2026_05_10_190845_01_create_deployment_connections_table.php, packages/deployments/database/migrations/2026_06_07_090000_02_create_deployment_publications_table.php, packages/deployments/database/migrations/2026_07_12_000001_create_deployment_publication_authorizations_table.php.
  • Models: DeploymentConnection, DeploymentPublication, DeploymentPublicationAuthorization.
  • Filament classes: DeploymentConnectionPage, DeploymentConnectionFilamentWidget.
  • Route files: packages/deployments/routes/oauth.php.
  • Extension contracts: GitProviderContract, PublishesComposerChanges.
  • Events: DeploymentPublishFailed, DeploymentPublishSucceeded.
  • Actions: AuthorizeComposerPublicationAction, CancelDeploymentPublicationAction, ConnectDeploymentAction, ConsumeOAuthStateAction, CreateOAuthStateAction, ValidateOAuthStateAction, PrepareComposerRequirementCommitAction, PublishComposerRequirementAction, RecordDeploymentPublicationAction, RefreshDeploymentPublicationStatusAction, RefreshProviderTokenAction.
  • Data objects: ComposerPublicationOperationData, ComposerRequirementData, OAuthConnectionData, PublishComposerChangeResultData, PullRequestData, RepoFile.
  • Jobs: RefreshDeploymentPublicationStatusJob.
  • Manifest contributions: admin-page: Capell\Deployments\Manifest\DeploymentsAdminPageContribution, dashboard-widget: Capell\Deployments\Manifest\DeploymentsDashboardFilamentWidgetContribution, route: Capell\Deployments\Manifest\DeploymentsRoutesContribution.
  • Health checks: Capell\Deployments\Health\DeploymentsHealthCheck.
  • Blade views: packages/deployments/resources/views/filament/pages/deployment-connection.blade.php, packages/deployments/resources/views/filament/widgets/deployment-connection.blade.php.

Data Model

Section titled “Data Model”
  • Required tables: deployment_connections, deployment_publications, deployment_publication_authorizations.
  • Models: DeploymentConnection, DeploymentPublication, DeploymentPublicationAuthorization.
  • Migration files: 2026_05_10_190845_01_create_deployment_connections_table.php, 2026_06_07_090000_02_create_deployment_publications_table.php, 2026_07_12_000001_create_deployment_publication_authorizations_table.php.
  • Migration impact: run host migrations through the package install flow before opening package surfaces.
  • Deletion/retention behaviour: migrations declare cascade-on-delete relationships; no timed pruning or retention schedule is declared in capell.json.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core.
  • Admin navigation: declares admin-page: DeploymentsAdminPageContribution; each Filament page or resource controls its own navigation visibility.
  • Admin/editor extensions: dashboard-widget: DeploymentsDashboardFilamentWidgetContribution.
  • Permissions: View:DeploymentConnectionPage, Manage:DeploymentConnectionPage.
  • Public routes: loads routes/oauth.php; registers DeploymentsRoutesContribution.
  • Database changes: package migrations are declared.
  • Config: config/capell-deployments.php.
  • Settings: no package settings declared.
  • Queues or schedules: queue jobs RefreshDeploymentPublicationStatusJob.
  • Cache tags: none declared.
  • Commands: none declared.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-deployments.php.
  • Review middleware, throttling, signatures, and public-output safety in routes/oauth.php before exposing routes.

Troubleshooting

Section titled “Troubleshooting”
Symptom Likely cause Check Fix
Package surface is missing after install Provider or manifest is not loaded Confirm capell.json, package composer.json, and provider registration Reinstall the package, refresh Composer autoload, and clear host caches
Admin screen or command fails on missing table Package migrations have not run Check the tables listed in Data Model Run host migrations and rerun the focused package test
Route returns unexpected output Route cache, middleware, or signed URL setup does not match the package route file Check the route files listed in Technical Shape Clear route cache and verify middleware before exposing public routes
Background work does not run Queue worker or declared schedule is not active Check the jobs and scheduled commands listed in Technical Shape Start the queue worker or host scheduler, then run the focused command or package test

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/deployments.
  2. Run the required setup: php artisan migrate.
  3. Open the Deployment connection page before a repository is connected and confirm the admin workflow loads.

Next Steps

Section titled “Next Steps”