Deployment Artifacts
Deployment Artifacts
Deployment Artifacts are records that capture the key details of a project deployment — the environment, URL, version, and when it went live. They give your team and clients a clear, organised history of every release tied to a project.
What Is a Deployment Artifact?
A deployment artifact is not a file — it is a structured record in the CRM. Think of it as a release log entry that answers:
- What went live?
- Where is it running?
- When did it deploy?
- What version or tag is it?
- Are there any notes about this release?
Deployment records are linked to a project, not a client directly. Each project can have many deployment records, building up a complete release history.
Fields
| Field | Required | Description |
|---|---|---|
| Environment | Yes | The target environment for this deployment |
| URL | Yes | The live URL for this deployment |
| Version / Tag | No | Git tag, build number, release label (e.g. v1.4.2, build-2025-07-15) |
| Deployed At | Yes | Date and time the deployment occurred |
| Notes | No | Context about the release: features included, hotfixes, rollback notes |
Environment options
| Environment | When to use |
|---|---|
production |
The live environment accessible to end users |
staging |
Pre-production environment for final QA and client review |
development |
Internal development environment, not for client access |
Adding a Deployment Record
Deployment records are added from the Project Detail page.
- Navigate to Projects and open the relevant project.
- Click the Deployments tab.
- Click + Add Deployment.
- Fill in the fields:
- Select the Environment
- Enter the URL (must be a valid URL including
https://) - Enter the Version / Tag if applicable
- Set the Deployed At date and time
- Add any relevant Notes
- Click Save Deployment.
The record appears in the deployments list immediately, sorted by most recent first.
Viewing Deployment History
The Deployments tab on a project shows all deployment records in reverse chronological order (newest first).
What you can see at a glance
| Column | Description |
|---|---|
| Environment | Badge indicating production, staging, or development |
| URL | Clickable link to the deployed environment |
| Version | Tag or build number |
| Deployed At | Date and time of the release |
| Notes | Preview of any notes (click to expand) |
Click View on any record to see its full details.
Editing a Deployment Record
- Open the project's Deployments tab.
- Click Edit on the deployment record you want to update.
- Make changes to any field.
- Click Save.
Edit a deployment record when you need to correct a URL, update the version tag after a post-deployment tag, or add retrospective notes. Editing does not affect the Deployed At timestamp unless you explicitly change it.
Deleting a Deployment Record
- Open the project's Deployments tab.
- Click Delete on the deployment record.
- Confirm.
Only delete deployment records that were entered by mistake. Genuine past deployments — including failed or rolled-back ones — should be kept as a historical record. Add a note to indicate a rollback rather than deleting the record.
Use Cases
Tracking go-lives
When a project goes live on production, add a deployment record immediately. This timestamps the go-live event and gives you a clear point of reference for:
- Billing milestone triggers (e.g. "first invoice due on go-live date")
- Warranty/support period start dates
- Client sign-off documentation
Sharing URLs with clients
The production URL in the deployment record is the authoritative link. Share it with your client directly from the project or by referencing the Deployments tab during a project update call.
Staging review
Before a production release, add a staging deployment record. Share the staging URL with the client for review. Once approved, add the production deployment record after go-live.
Post-mortem reference
If a bug is reported, check the deployments tab to identify exactly which version was live at the time of the report. This is especially useful if multiple deployments happened in quick succession.
Client Visibility
Clients can see deployment records for their projects in the client portal, under the relevant project. The production and staging URLs are displayed as clickable links. This gives clients direct access to their live environments without needing to contact your team for the URL.
When adding a production deployment record, use the Notes field to summarise what is in the release (e.g. "Version 1.2 — includes the new payment flow and updated dashboard"). Clients appreciate release notes that explain what changed.