personal-projects/personal-portfolio
Template
1
1
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Create docs/runbooks/deployment.md #88

New Issue
Closed
opened 2026-01-17 21:53:48 +00:00 by lmiranda · 0 comments
lmiranda commented 2026-01-17 21:53:48 +00:00
Owner
Copy Link

Overview

Create a runbook documenting both manual and automated deployment procedures, including rollback steps.

Acceptance Criteria

  • Create docs/runbooks/deployment.md
  • Document manual deployment steps:
    • SSH access
    • Git pull
    • Dependencies update
    • dbt run
    • Service restart
  • Document CI/CD automated deployment:
    • How staging deployment triggers
    • How production deployment triggers
    • Required secrets configuration
  • Document rollback procedure:
    • Git revert steps
    • Database rollback (if applicable)
    • Service restart
  • Include troubleshooting section
  • Reference environment-specific configurations

Technical Notes

Sections to include:

  1. Prerequisites (SSH access, secrets, permissions)
  2. Manual Deployment (step-by-step)
  3. Automated CI/CD Deployment (how it works)
  4. Rollback Procedure (emergency recovery)
  5. Troubleshooting (common issues)
  6. Environment Variables Reference

Labels

  • Type/Documentation
  • Priority/Medium
  • Complexity/Medium
  • Component/Docs
  • Component/Deploy

Phase: 4 - Runbooks

## Overview Create a runbook documenting both manual and automated deployment procedures, including rollback steps. ## Acceptance Criteria - [ ] Create `docs/runbooks/deployment.md` - [ ] Document manual deployment steps: - [ ] SSH access - [ ] Git pull - [ ] Dependencies update - [ ] dbt run - [ ] Service restart - [ ] Document CI/CD automated deployment: - [ ] How staging deployment triggers - [ ] How production deployment triggers - [ ] Required secrets configuration - [ ] Document rollback procedure: - [ ] Git revert steps - [ ] Database rollback (if applicable) - [ ] Service restart - [ ] Include troubleshooting section - [ ] Reference environment-specific configurations ## Technical Notes Sections to include: 1. Prerequisites (SSH access, secrets, permissions) 2. Manual Deployment (step-by-step) 3. Automated CI/CD Deployment (how it works) 4. Rollback Procedure (emergency recovery) 5. Troubleshooting (common issues) 6. Environment Variables Reference ## Labels - Type/Documentation - Priority/Medium - Complexity/Medium - Component/Docs - Component/Deploy ## Phase: 4 - Runbooks
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Complexity/Complex
High uncertainty or many dependencies
 Complexity/Medium
Some unknowns or dependencies
 Complexity/Simple
Straightforward, well-understood
 Effort/L
3-5 days
 Effort/M
1-2 days
 Effort/S
2-4 hours
 Effort/XL
> 1 week
 Effort/XS
< 2 hours
 Priority/Critical
Immediate attention required
 Priority/High
Important, needs attention soon
 Priority/Low
Nice to have, can wait
 Priority/Medium
Normal priority
 Type/Bug
Something isn't working
 Type/Chore
Maintenance tasks
 Type/Documentation
Documentation improvements
 Type/Feature
New feature or request
 Type/Refactor
Code refactoring without changing behavior
 Type/Test
Testing related
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
lmiranda
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: personal-projects/personal-portfolio#88
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?