@codigodoleo/wp-kit 2.0.4 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.cspell.json +5 -25
- package/README.md +127 -2
- package/lib/cli.js +1 -0
- package/lib/commands/init.js +32 -10
- package/lib/config/versions.js +163 -0
- package/lib/core/generator.js +63 -46
- package/lib/core/hook-manager.js +2 -2
- package/lib/core/infer-ci-capabilities.js +13 -24
- package/lib/prompts/index.js +31 -19
- package/lib/prompts/loadModulePrompts.js +4 -2
- package/lib/utils/generate-from-template.js +1 -0
- package/modules/deploy/index.js +34 -7
- package/modules/deploy/prompts.js +5 -5
- package/modules/deploy/templates/.github/workflows/ci.yml.hbs +49 -103
- package/modules/deploy/templates/.gitlab/gitlab-ci.yml.hbs +45 -145
- package/modules/deploy/templates/bitbucket-pipelines.yml.hbs +46 -97
- package/modules/docs/prompts.js +2 -2
- package/modules/docs/templates/README.md.hbs +67 -160
- package/modules/docs/templates/docs/Arquitetura.md +113 -92
- package/modules/docs/templates/docs/Deploy-Pipeline.md +22 -8
- package/modules/docs/templates/docs/Desenvolvimento.md +187 -164
- package/modules/docs/templates/docs/Getting-Started.md +37 -7
- package/modules/docs/templates/docs/Infraestrutura.md +41 -12
- package/modules/docs/templates/docs/Monitoramento.md +83 -45
- package/modules/docs/templates/docs/Sync-the-Production-DB-with-the-Staging-DB.md +6 -7
- package/modules/docs/templates/docs/Troubleshooting.md +1 -1
- package/modules/git/.github/PULL_REQUEST_TEMPLATE.md +1 -0
- package/modules/git/.gitlab/merge_request_templates/default.md +1 -0
- package/modules/git/.vscode/commit-instructions.md +7 -0
- package/modules/git/.vscode/conventional-commits.code-snippets +13 -43
- package/modules/git/docs/CONVENTIONAL-COMMITS.md +14 -14
- package/modules/git/index.js +39 -34
- package/modules/git/prompts.js +4 -4
- package/modules/git/templates/.lando.yml.hbs +5 -13
- package/modules/git/templates/package.json.hbs +4 -15
- package/modules/git/templates/workspace.json.hbs +28 -114
- package/modules/lint/eslint.config.mjs +36 -0
- package/modules/lint/index.js +1 -2
- package/modules/lint/prompts.js +3 -3
- package/modules/lint/templates/.lando.yml.hbs +2 -10
- package/modules/lint/templates/package.json.hbs +4 -16
- package/modules/lint/templates/workspace.json.hbs +15 -56
- package/modules/php/prompts.js +2 -2
- package/modules/php/templates/.lando.yml.hbs +2 -11
- package/modules/php/templates/composer.json.hbs +1 -6
- package/modules/php/templates/workspace.json.hbs +15 -74
- package/modules/redis/prompts.js +2 -2
- package/modules/redis/templates/.lando.yml.hbs +1 -8
- package/modules/sage/index.js +115 -7
- package/modules/sage/prompts.js +3 -3
- package/modules/sage/templates/.lando.yml.hbs +20 -64
- package/modules/sage/templates/theme/composer.json.hbs +3 -18
- package/modules/sage/templates/theme/package.json.hbs +3 -11
- package/modules/sage/templates/theme/style.css.hbs +20 -13
- package/modules/sage/templates/theme/vite.config.js.hbs +13 -53
- package/modules/sage/templates/workspace.json.hbs +12 -67
- package/modules/test-directory/prompts.js +2 -2
- package/package.json +20 -1
- package/templates/.editorconfig.hbs +5 -39
- package/templates/.env.hbs +14 -35
- package/templates/.gitignore.hbs +13 -86
- package/templates/.lando.yml.hbs +11 -44
- package/templates/README.md.hbs +7 -8
- package/templates/composer.json.hbs +12 -60
- package/templates/server/cmd/install-wp.sh.hbs +43 -58
- package/templates/server/www/vhosts.conf.hbs +21 -71
- package/templates/workspace.json.hbs +40 -177
|
@@ -5,12 +5,14 @@ Documentação do sistema de monitoramento e observabilidade do Pipefy Website,
|
|
|
5
5
|
## 🎯 **Visão Geral do Monitoramento**
|
|
6
6
|
|
|
7
7
|
### **Objetivos**
|
|
8
|
+
|
|
8
9
|
- Garantir disponibilidade e performance do site
|
|
9
10
|
- Detectar problemas antes que afetem usuários
|
|
10
11
|
- Fornecer insights para otimização
|
|
11
12
|
- Manter SLAs definidos
|
|
12
13
|
|
|
13
14
|
### **Stack de Observabilidade**
|
|
15
|
+
|
|
14
16
|
- **Metrics**: `[SRE_DETAIL: Prometheus, CloudWatch, OCI Monitoring]`
|
|
15
17
|
- **Logs**: `[SRE_DETAIL: ELK Stack, Fluentd, OCI Logging]`
|
|
16
18
|
- **Traces**: `[SRE_DETAIL: Jaeger, Zipkin, ou APM solution]`
|
|
@@ -19,22 +21,25 @@ Documentação do sistema de monitoramento e observabilidade do Pipefy Website,
|
|
|
19
21
|
## 📈 **Métricas Principais**
|
|
20
22
|
|
|
21
23
|
### **Application Metrics**
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
|
25
|
-
| **
|
|
26
|
-
| **
|
|
27
|
-
| **
|
|
24
|
+
|
|
25
|
+
| Métrica | Threshold | Alertas | Responsável |
|
|
26
|
+
| ----------------- | ------------------------- | --------------------------- | ----------- |
|
|
27
|
+
| **Response Time** | `[SRE_DETAIL: < Xs]` | `[SRE_DETAIL: Alert rules]` | Dev Team |
|
|
28
|
+
| **Error Rate** | `[SRE_DETAIL: < X%]` | `[SRE_DETAIL: Alert rules]` | Dev Team |
|
|
29
|
+
| **Throughput** | `[SRE_DETAIL: > X req/s]` | `[SRE_DETAIL: Alert rules]` | SRE Team |
|
|
30
|
+
| **Availability** | `[SRE_DETAIL: > XX.X%]` | `[SRE_DETAIL: Alert rules]` | SRE Team |
|
|
28
31
|
|
|
29
32
|
### **Infrastructure Metrics**
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
|
33
|
-
| **
|
|
34
|
-
| **
|
|
35
|
-
| **
|
|
33
|
+
|
|
34
|
+
| Componente | Métricas Monitoradas | Thresholds |
|
|
35
|
+
| ------------------- | ------------------------------- | ----------------------------------- |
|
|
36
|
+
| **Kubernetes Pods** | CPU, Memory, Restarts | `[SRE_DETAIL: Limites específicos]` |
|
|
37
|
+
| **Database** | Connections, Query time, Locks | `[SRE_DETAIL: Limites específicos]` |
|
|
38
|
+
| **Storage** | Disk usage, I/O operations | `[SRE_DETAIL: Limites específicos]` |
|
|
39
|
+
| **Network** | Bandwidth, Latency, Packet loss | `[SRE_DETAIL: Limites específicos]` |
|
|
36
40
|
|
|
37
41
|
### **Business Metrics**
|
|
42
|
+
|
|
38
43
|
- **Page Views**: `[SRE_DETAIL: Tracking method e baseline]`
|
|
39
44
|
- **User Sessions**: `[SRE_DETAIL: Analytics integration]`
|
|
40
45
|
- **Conversion Rate**: `[SRE_DETAIL: Goals e funnels]`
|
|
@@ -43,20 +48,23 @@ Documentação do sistema de monitoramento e observabilidade do Pipefy Website,
|
|
|
43
48
|
## 🚨 **Sistema de Alertas**
|
|
44
49
|
|
|
45
50
|
### **Níveis de Severidade**
|
|
46
|
-
|
|
47
|
-
|
|
51
|
+
|
|
52
|
+
| Nível | Descrição | Resposta Esperada | Escalação |
|
|
53
|
+
| ----------------- | -------------------- | ------------------- | -------------------------------- |
|
|
48
54
|
| **P1 - Critical** | Site down, data loss | Imediata (< 15 min) | `[SRE_DETAIL: On-call rotation]` |
|
|
49
|
-
| **P2 - High**
|
|
50
|
-
| **P3 - Medium**
|
|
51
|
-
| **P4 - Low**
|
|
55
|
+
| **P2 - High** | Performance degraded | < 1 hora | `[SRE_DETAIL: Team lead]` |
|
|
56
|
+
| **P3 - Medium** | Minor issues | < 4 horas | `[SRE_DETAIL: Dev team]` |
|
|
57
|
+
| **P4 - Low** | Warnings, capacity | Next business day | `[SRE_DETAIL: Planning]` |
|
|
52
58
|
|
|
53
59
|
### **Canais de Notificação**
|
|
60
|
+
|
|
54
61
|
- **Slack**: `[SRE_DETAIL: Channels configurados (#alerts, #devops)]`
|
|
55
62
|
- **Email**: `[SRE_DETAIL: Distribution lists]`
|
|
56
63
|
- **PagerDuty**: `[SRE_DETAIL: On-call schedule]`
|
|
57
64
|
- **SMS**: `[SRE_DETAIL: Critical alerts only]`
|
|
58
65
|
|
|
59
66
|
### **Alert Rules**
|
|
67
|
+
|
|
60
68
|
```
|
|
61
69
|
Site Down (P1):
|
|
62
70
|
- HTTP 5xx > 50% por 2 minutos
|
|
@@ -74,18 +82,21 @@ Database Issues (P1/P2):
|
|
|
74
82
|
## 📋 **Dashboards**
|
|
75
83
|
|
|
76
84
|
### **Executive Dashboard**
|
|
85
|
+
|
|
77
86
|
- **Uptime**: Overall availability
|
|
78
87
|
- **Performance**: Average response time
|
|
79
88
|
- **User Impact**: Active users, page views
|
|
80
89
|
- **Business KPIs**: `[SRE_DETAIL: Specific business metrics]`
|
|
81
90
|
|
|
82
91
|
### **Operations Dashboard**
|
|
92
|
+
|
|
83
93
|
- **Infrastructure Health**: Pods, nodes, storage
|
|
84
94
|
- **Application Performance**: Response times, errors
|
|
85
95
|
- **Security Events**: `[SRE_DETAIL: Security monitoring metrics]`
|
|
86
96
|
- **Deployment Status**: `[SRE_DETAIL: CI/CD pipeline metrics]`
|
|
87
97
|
|
|
88
98
|
### **Development Dashboard**
|
|
99
|
+
|
|
89
100
|
- **Error Rates**: By endpoint, feature
|
|
90
101
|
- **Performance Trends**: Historical data
|
|
91
102
|
- **User Experience**: `[SRE_DETAIL: Frontend performance metrics]`
|
|
@@ -94,26 +105,29 @@ Database Issues (P1/P2):
|
|
|
94
105
|
## 🔍 **Health Checks**
|
|
95
106
|
|
|
96
107
|
### **Application Health Checks**
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
|
100
|
-
| `/wp-
|
|
108
|
+
|
|
109
|
+
| Endpoint | Frequency | Timeout | Expected Response |
|
|
110
|
+
| ------------------------------- | ------------------ | ------------------ | ------------------------ |
|
|
111
|
+
| `/wp-json/wp/v2/` | `[SRE_DETAIL: Xs]` | `[SRE_DETAIL: Xs]` | HTTP 200 |
|
|
112
|
+
| `/wp-admin/admin-ajax.php` | `[SRE_DETAIL: Xs]` | `[SRE_DETAIL: Xs]` | HTTP 200 |
|
|
101
113
|
| `[SRE_DETAIL: Custom endpoint]` | `[SRE_DETAIL: Xs]` | `[SRE_DETAIL: Xs]` | `[SRE_DETAIL: Expected]` |
|
|
102
114
|
|
|
103
115
|
### **External Dependencies**
|
|
116
|
+
|
|
104
117
|
- **Database**: `[SRE_DETAIL: Connection check frequency]`
|
|
105
118
|
- **CDN (CloudFlare)**: `[SRE_DETAIL: Edge health monitoring]`
|
|
106
119
|
- **Third-party APIs**: `[SRE_DETAIL: External service monitoring]`
|
|
107
120
|
- **Object Storage**: `[SRE_DETAIL: Storage accessibility check]`
|
|
108
121
|
|
|
109
122
|
### **Kubernetes Health Checks**
|
|
123
|
+
|
|
110
124
|
```yaml
|
|
111
125
|
livenessProbe:
|
|
112
126
|
# [SRE_DETAIL: Configuração específica]
|
|
113
|
-
|
|
127
|
+
|
|
114
128
|
readinessProbe:
|
|
115
129
|
# [SRE_DETAIL: Configuração específica]
|
|
116
|
-
|
|
130
|
+
|
|
117
131
|
startupProbe:
|
|
118
132
|
# [SRE_DETAIL: Configuração específica]
|
|
119
133
|
```
|
|
@@ -121,21 +135,24 @@ startupProbe:
|
|
|
121
135
|
## 📊 **SLIs e SLOs**
|
|
122
136
|
|
|
123
137
|
### **Service Level Indicators (SLIs)**
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
|
127
|
-
| **
|
|
128
|
-
| **
|
|
129
|
-
| **
|
|
138
|
+
|
|
139
|
+
| SLI | Medição | Fonte de Dados |
|
|
140
|
+
| ---------------- | ------------------------------------ | ----------------------------------- |
|
|
141
|
+
| **Availability** | Successful requests / Total requests | `[SRE_DETAIL: Load balancer logs]` |
|
|
142
|
+
| **Latency** | Response time < Xms | `[SRE_DETAIL: Application metrics]` |
|
|
143
|
+
| **Error Rate** | Error responses / Total responses | `[SRE_DETAIL: Application logs]` |
|
|
144
|
+
| **Throughput** | Requests per second | `[SRE_DETAIL: Ingress metrics]` |
|
|
130
145
|
|
|
131
146
|
### **Service Level Objectives (SLOs)**
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
|
135
|
-
| **
|
|
136
|
-
| **
|
|
147
|
+
|
|
148
|
+
| SLO | Target | Measurement Window | Error Budget |
|
|
149
|
+
| ----------------- | ------------------------ | ------------------ | ------------------------- |
|
|
150
|
+
| **Availability** | `[SRE_DETAIL: 99.X%]` | 30 days | `[SRE_DETAIL: X hours]` |
|
|
151
|
+
| **Response Time** | `[SRE_DETAIL: XX% < Xs]` | 24 hours | `[SRE_DETAIL: X% budget]` |
|
|
152
|
+
| **Error Rate** | `[SRE_DETAIL: < X%]` | 24 hours | `[SRE_DETAIL: X% budget]` |
|
|
137
153
|
|
|
138
154
|
### **Error Budget Policy**
|
|
155
|
+
|
|
139
156
|
- **Budget Remaining > 50%**: `[SRE_DETAIL: Normal operations]`
|
|
140
157
|
- **Budget Remaining 10-50%**: `[SRE_DETAIL: Increased monitoring]`
|
|
141
158
|
- **Budget Remaining < 10%**: `[SRE_DETAIL: Feature freeze policy]`
|
|
@@ -143,12 +160,14 @@ startupProbe:
|
|
|
143
160
|
## 🔐 **Security Monitoring**
|
|
144
161
|
|
|
145
162
|
### **Security Events**
|
|
163
|
+
|
|
146
164
|
- **Failed Login Attempts**: `[SRE_DETAIL: Threshold e response]`
|
|
147
165
|
- **Unusual Traffic Patterns**: `[SRE_DETAIL: DDoS detection]`
|
|
148
166
|
- **File System Changes**: `[SRE_DETAIL: File integrity monitoring]`
|
|
149
167
|
- **Privilege Escalation**: `[SRE_DETAIL: RBAC violations]`
|
|
150
168
|
|
|
151
169
|
### **Compliance Monitoring**
|
|
170
|
+
|
|
152
171
|
- **Access Logs**: `[SRE_DETAIL: Retention policy]`
|
|
153
172
|
- **Data Protection**: `[SRE_DETAIL: GDPR compliance metrics]`
|
|
154
173
|
- **Security Patches**: `[SRE_DETAIL: Vulnerability scanning]`
|
|
@@ -157,20 +176,23 @@ startupProbe:
|
|
|
157
176
|
## 📝 **Logging Strategy**
|
|
158
177
|
|
|
159
178
|
### **Log Types**
|
|
160
|
-
|
|
161
|
-
|
|
179
|
+
|
|
180
|
+
| Log Type | Retention | Format | Storage |
|
|
181
|
+
| -------------------- | ---------------------- | -------------------------- | ------------------------ |
|
|
162
182
|
| **Application Logs** | `[SRE_DETAIL: X days]` | `[SRE_DETAIL: JSON/Plain]` | `[SRE_DETAIL: Location]` |
|
|
163
|
-
| **Access Logs**
|
|
164
|
-
| **Error Logs**
|
|
165
|
-
| **Security Logs**
|
|
183
|
+
| **Access Logs** | `[SRE_DETAIL: X days]` | `[SRE_DETAIL: Format]` | `[SRE_DETAIL: Location]` |
|
|
184
|
+
| **Error Logs** | `[SRE_DETAIL: X days]` | `[SRE_DETAIL: Format]` | `[SRE_DETAIL: Location]` |
|
|
185
|
+
| **Security Logs** | `[SRE_DETAIL: X days]` | `[SRE_DETAIL: Format]` | `[SRE_DETAIL: Location]` |
|
|
166
186
|
|
|
167
187
|
### **Log Aggregation**
|
|
188
|
+
|
|
168
189
|
- **Collection**: `[SRE_DETAIL: Fluentd, Filebeat, ou similar]`
|
|
169
190
|
- **Processing**: `[SRE_DETAIL: Logstash, ou stream processing]`
|
|
170
191
|
- **Storage**: `[SRE_DETAIL: Elasticsearch, OCI Logging]`
|
|
171
192
|
- **Visualization**: `[SRE_DETAIL: Kibana, Grafana]`
|
|
172
193
|
|
|
173
194
|
### **Log Analysis**
|
|
195
|
+
|
|
174
196
|
- **Error Pattern Detection**: `[SRE_DETAIL: Automated analysis]`
|
|
175
197
|
- **Performance Insights**: `[SRE_DETAIL: Slow query detection]`
|
|
176
198
|
- **Security Analysis**: `[SRE_DETAIL: Threat detection]`
|
|
@@ -179,20 +201,23 @@ startupProbe:
|
|
|
179
201
|
## 🔄 **Incident Response**
|
|
180
202
|
|
|
181
203
|
### **Runbooks**
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
|
185
|
-
| **
|
|
186
|
-
| **
|
|
204
|
+
|
|
205
|
+
| Cenário | Runbook | Owner | Automation Level |
|
|
206
|
+
| --------------------- | --------------------------------- | ------------- | --------------------------- |
|
|
207
|
+
| **Site Down** | `[SRE_DETAIL: Link para runbook]` | SRE Team | `[SRE_DETAIL: Manual/Auto]` |
|
|
208
|
+
| **High CPU** | `[SRE_DETAIL: Link para runbook]` | Dev Team | `[SRE_DETAIL: Manual/Auto]` |
|
|
209
|
+
| **Database Issues** | `[SRE_DETAIL: Link para runbook]` | DBA Team | `[SRE_DETAIL: Manual/Auto]` |
|
|
187
210
|
| **Security Incident** | `[SRE_DETAIL: Link para runbook]` | Security Team | `[SRE_DETAIL: Manual/Auto]` |
|
|
188
211
|
|
|
189
212
|
### **Auto-Remediation**
|
|
213
|
+
|
|
190
214
|
- **Pod Restart**: `[SRE_DETAIL: Conditions for automatic restart]`
|
|
191
215
|
- **Scale Up**: `[SRE_DETAIL: HPA triggers]`
|
|
192
216
|
- **Cache Clear**: `[SRE_DETAIL: Performance degradation triggers]`
|
|
193
217
|
- **Circuit Breaker**: `[SRE_DETAIL: Dependency failure handling]`
|
|
194
218
|
|
|
195
219
|
### **Escalation Matrix**
|
|
220
|
+
|
|
196
221
|
```
|
|
197
222
|
Level 1: On-call Engineer (0-15 min)
|
|
198
223
|
Level 2: Team Lead (15-30 min)
|
|
@@ -205,12 +230,14 @@ Level 4: Director (60+ min)
|
|
|
205
230
|
## 📱 **Synthetic Monitoring**
|
|
206
231
|
|
|
207
232
|
### **Uptime Monitoring**
|
|
233
|
+
|
|
208
234
|
- **External Providers**: `[SRE_DETAIL: Pingdom, StatusCake, etc.]`
|
|
209
235
|
- **Check Frequency**: `[SRE_DETAIL: Interval]`
|
|
210
236
|
- **Global Locations**: `[SRE_DETAIL: Geographic distribution]`
|
|
211
237
|
- **Alert Thresholds**: `[SRE_DETAIL: Failure conditions]`
|
|
212
238
|
|
|
213
239
|
### **User Journey Monitoring**
|
|
240
|
+
|
|
214
241
|
- **Critical Paths**: `[SRE_DETAIL: Key user flows to monitor]`
|
|
215
242
|
- **Performance Budgets**: `[SRE_DETAIL: Load time thresholds]`
|
|
216
243
|
- **Browser Testing**: `[SRE_DETAIL: Cross-browser compatibility]`
|
|
@@ -219,12 +246,14 @@ Level 4: Director (60+ min)
|
|
|
219
246
|
## 🎯 **Performance Monitoring**
|
|
220
247
|
|
|
221
248
|
### **Frontend Performance**
|
|
249
|
+
|
|
222
250
|
- **Core Web Vitals**: `[SRE_DETAIL: LCP, FID, CLS thresholds]`
|
|
223
251
|
- **Page Load Times**: `[SRE_DETAIL: Measurement tools]`
|
|
224
252
|
- **JavaScript Errors**: `[SRE_DETAIL: Error tracking solution]`
|
|
225
253
|
- **User Experience**: `[SRE_DETAIL: Real User Monitoring]`
|
|
226
254
|
|
|
227
255
|
### **Backend Performance**
|
|
256
|
+
|
|
228
257
|
- **API Response Times**: `[SRE_DETAIL: Endpoint-specific SLOs]`
|
|
229
258
|
- **Database Performance**: `[SRE_DETAIL: Query optimization metrics]`
|
|
230
259
|
- **Cache Hit Rates**: `[SRE_DETAIL: CDN and application cache]`
|
|
@@ -233,12 +262,14 @@ Level 4: Director (60+ min)
|
|
|
233
262
|
## 📊 **Capacity Planning**
|
|
234
263
|
|
|
235
264
|
### **Growth Metrics**
|
|
265
|
+
|
|
236
266
|
- **Traffic Trends**: `[SRE_DETAIL: Historical growth patterns]`
|
|
237
267
|
- **Resource Usage**: `[SRE_DETAIL: Infrastructure scaling needs]`
|
|
238
268
|
- **Storage Growth**: `[SRE_DETAIL: Data retention and archival]`
|
|
239
269
|
- **Cost Optimization**: `[SRE_DETAIL: Resource right-sizing]`
|
|
240
270
|
|
|
241
271
|
### **Forecasting**
|
|
272
|
+
|
|
242
273
|
- **Predictive Analysis**: `[SRE_DETAIL: Tools and methodologies]`
|
|
243
274
|
- **Seasonal Patterns**: `[SRE_DETAIL: Traffic seasonality]`
|
|
244
275
|
- **Scaling Triggers**: `[SRE_DETAIL: Proactive scaling thresholds]`
|
|
@@ -247,18 +278,21 @@ Level 4: Director (60+ min)
|
|
|
247
278
|
## 📋 **Action Items para SRE**
|
|
248
279
|
|
|
249
280
|
### **🔴 Crítico (Implementação Necessária)**
|
|
281
|
+
|
|
250
282
|
- [ ] Definir e implementar SLOs específicos para o site
|
|
251
283
|
- [ ] Configurar alertas críticos com thresholds apropriados
|
|
252
284
|
- [ ] Estabelecer on-call rotation e escalation procedures
|
|
253
285
|
- [ ] Implementar health checks abrangentes
|
|
254
286
|
|
|
255
287
|
### **🟡 Importante (Melhoria)**
|
|
288
|
+
|
|
256
289
|
- [ ] Configurar dashboards operacionais e executivos
|
|
257
290
|
- [ ] Implementar synthetic monitoring externo
|
|
258
291
|
- [ ] Estabelecer log aggregation e analysis
|
|
259
292
|
- [ ] Criar runbooks para cenários comuns
|
|
260
293
|
|
|
261
294
|
### **🟢 Desejável (Otimização)**
|
|
295
|
+
|
|
262
296
|
- [ ] Implementar auto-remediation para problemas comuns
|
|
263
297
|
- [ ] Configurar capacity planning automatizado
|
|
264
298
|
- [ ] Implementar advanced APM solution
|
|
@@ -267,12 +301,14 @@ Level 4: Director (60+ min)
|
|
|
267
301
|
## 📞 **Responsabilidades e Contatos**
|
|
268
302
|
|
|
269
303
|
### **Monitoring Ownership**
|
|
304
|
+
|
|
270
305
|
- **SRE Team**: Infrastructure metrics, alerting, SLOs
|
|
271
306
|
- **Development Team**: Application metrics, error tracking
|
|
272
307
|
- **Security Team**: Security monitoring, compliance
|
|
273
308
|
- **Business Team**: Business metrics, user experience
|
|
274
309
|
|
|
275
310
|
### **Tools and Access**
|
|
311
|
+
|
|
276
312
|
- **Monitoring Tools**: `[SRE_DETAIL: Access management]`
|
|
277
313
|
- **Alert Management**: `[SRE_DETAIL: Who can modify alerts]`
|
|
278
314
|
- **Dashboard Creation**: `[SRE_DETAIL: Self-service capabilities]`
|
|
@@ -281,12 +317,14 @@ Level 4: Director (60+ min)
|
|
|
281
317
|
## 🔄 **Continuous Improvement**
|
|
282
318
|
|
|
283
319
|
### **Monitoring Review Process**
|
|
320
|
+
|
|
284
321
|
- **Monthly SLO Review**: `[SRE_DETAIL: Meeting cadence]`
|
|
285
322
|
- **Alert Tuning**: `[SRE_DETAIL: Noise reduction process]`
|
|
286
323
|
- **Dashboard Optimization**: `[SRE_DETAIL: User feedback integration]`
|
|
287
324
|
- **Tool Evaluation**: `[SRE_DETAIL: Technology refresh cycle]`
|
|
288
325
|
|
|
289
326
|
### **Metrics Evolution**
|
|
327
|
+
|
|
290
328
|
- **New Metrics**: `[SRE_DETAIL: Request and approval process]`
|
|
291
329
|
- **Deprecated Metrics**: `[SRE_DETAIL: Sunset process]`
|
|
292
330
|
- **Business Alignment**: `[SRE_DETAIL: KPI alignment reviews]`
|
|
@@ -299,4 +337,4 @@ Level 4: Director (60+ min)
|
|
|
299
337
|
🚨 **Alerting**: `[SRE_DETAIL: Primary alerting system]`
|
|
300
338
|
📈 **SLOs**: A serem definidos pela equipe SRE
|
|
301
339
|
🔄 **Estado**: Necessita implementação detalhada
|
|
302
|
-
🎯 **Próximos passos**: Preenchimento dos `[SRE_DETAIL]` e implementação das action items
|
|
340
|
+
🎯 **Próximos passos**: Preenchimento dos `[SRE_DETAIL]` e implementação das action items
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
1. Inside GitLab:
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
4. Done! Staging environment's updated now.
|
|
2
|
+
1. Go to [CI/CD -> Schedules](https://git.pipefy.net/wordpress/pipefy-website/-/pipeline_schedules).
|
|
3
|
+
2. Press the play button on the `Download Prod Database` scheduled pipeline.
|
|
4
|
+
1. It'll create a database backup and store it in the S3 bucket.
|
|
5
|
+
3. After finishing the job above, press the play button on the `Replicate Production DB into Staging DB` scheduled pipeline.
|
|
6
|
+
1. That last job uses the database backup inside the S3 bucket
|
|
7
|
+
4. Done! Staging environment's updated now.
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
When generating commit messages, follow these guidelines:
|
|
4
4
|
|
|
5
5
|
## Format
|
|
6
|
+
|
|
6
7
|
```
|
|
7
8
|
<type>(<scope>): <description>
|
|
8
9
|
|
|
@@ -12,6 +13,7 @@ When generating commit messages, follow these guidelines:
|
|
|
12
13
|
```
|
|
13
14
|
|
|
14
15
|
## Rules
|
|
16
|
+
|
|
15
17
|
- **First line max 72 characters**
|
|
16
18
|
- **Use imperative mood** ("add" not "added")
|
|
17
19
|
- **Lowercase first letter**
|
|
@@ -22,6 +24,7 @@ When generating commit messages, follow these guidelines:
|
|
|
22
24
|
- **Footer**: Optional, breaking changes and issue references
|
|
23
25
|
|
|
24
26
|
## Available Types
|
|
27
|
+
|
|
25
28
|
- `feat`: A new feature
|
|
26
29
|
- `fix`: A bug fix
|
|
27
30
|
- `docs`: Documentation changes
|
|
@@ -37,6 +40,7 @@ When generating commit messages, follow these guidelines:
|
|
|
37
40
|
- `release`: Version release
|
|
38
41
|
|
|
39
42
|
## Examples
|
|
43
|
+
|
|
40
44
|
- `feat(auth): add user login functionality`
|
|
41
45
|
- `fix(ui): resolve header alignment on mobile`
|
|
42
46
|
- `docs(readme): update installation guide`
|
|
@@ -49,11 +53,14 @@ When generating commit messages, follow these guidelines:
|
|
|
49
53
|
- `build(webpack): optimize production bundle`
|
|
50
54
|
|
|
51
55
|
## Breaking Changes
|
|
56
|
+
|
|
52
57
|
Add `BREAKING CHANGE:` in footer for breaking changes.
|
|
53
58
|
|
|
54
59
|
## Issue References
|
|
60
|
+
|
|
55
61
|
Add `Closes #123` or `Fixes #123` in footer for issue references.
|
|
56
62
|
|
|
57
63
|
## AI Generation Prompt
|
|
64
|
+
|
|
58
65
|
When using AI tools (Copilot, GitLens), use this prompt:
|
|
59
66
|
"Generate a conventional commit message for the staged changes. Use format: <type>(<scope>): <description>. Available types: feat, fix, docs, style, refactor, perf, test, chore, ci, build, revert, hotfix, release. Keep under 72 characters, imperative mood, lowercase, no ending period."
|
|
@@ -1,62 +1,32 @@
|
|
|
1
1
|
{
|
|
2
2
|
"Conventional Commit - feat": {
|
|
3
3
|
"prefix": "cc-feat",
|
|
4
|
-
"body": [
|
|
5
|
-
|
|
6
|
-
"",
|
|
7
|
-
"$3",
|
|
8
|
-
"",
|
|
9
|
-
"$4"
|
|
10
|
-
],
|
|
11
|
-
"description": "Template for new feature"
|
|
4
|
+
"body": ["feat($1): $2", "", "$3", "", "$4"],
|
|
5
|
+
"description": "Template for new feature",
|
|
12
6
|
},
|
|
13
7
|
"Conventional Commit - fix": {
|
|
14
8
|
"prefix": "cc-fix",
|
|
15
|
-
"body": [
|
|
16
|
-
|
|
17
|
-
"",
|
|
18
|
-
"$3",
|
|
19
|
-
"",
|
|
20
|
-
"Fixes #$4"
|
|
21
|
-
],
|
|
22
|
-
"description": "Template for bug fix"
|
|
9
|
+
"body": ["fix($1): $2", "", "$3", "", "Fixes #$4"],
|
|
10
|
+
"description": "Template for bug fix",
|
|
23
11
|
},
|
|
24
12
|
"Conventional Commit - docs": {
|
|
25
13
|
"prefix": "cc-docs",
|
|
26
|
-
"body": [
|
|
27
|
-
|
|
28
|
-
"",
|
|
29
|
-
"$3"
|
|
30
|
-
],
|
|
31
|
-
"description": "Template for documentation"
|
|
14
|
+
"body": ["docs($1): $2", "", "$3"],
|
|
15
|
+
"description": "Template for documentation",
|
|
32
16
|
},
|
|
33
17
|
"Conventional Commit - refactor": {
|
|
34
18
|
"prefix": "cc-refactor",
|
|
35
|
-
"body": [
|
|
36
|
-
|
|
37
|
-
"",
|
|
38
|
-
"$3"
|
|
39
|
-
],
|
|
40
|
-
"description": "Template for refactoring"
|
|
19
|
+
"body": ["refactor($1): $2", "", "$3"],
|
|
20
|
+
"description": "Template for refactoring",
|
|
41
21
|
},
|
|
42
22
|
"Conventional Commit - chore": {
|
|
43
23
|
"prefix": "cc-chore",
|
|
44
|
-
"body": [
|
|
45
|
-
|
|
46
|
-
"",
|
|
47
|
-
"$3"
|
|
48
|
-
],
|
|
49
|
-
"description": "Template for maintenance tasks"
|
|
24
|
+
"body": ["chore($1): $2", "", "$3"],
|
|
25
|
+
"description": "Template for maintenance tasks",
|
|
50
26
|
},
|
|
51
27
|
"Conventional Commit - breaking change": {
|
|
52
28
|
"prefix": "cc-breaking",
|
|
53
|
-
"body": [
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
"BREAKING CHANGE: $4",
|
|
57
|
-
"",
|
|
58
|
-
"$5"
|
|
59
|
-
],
|
|
60
|
-
"description": "Template for breaking change"
|
|
61
|
-
}
|
|
29
|
+
"body": ["$1($2): $3", "", "BREAKING CHANGE: $4", "", "$5"],
|
|
30
|
+
"description": "Template for breaking change",
|
|
31
|
+
},
|
|
62
32
|
}
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
Install the recommended extensions that will appear automatically:
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
- **Conventional Commits**: Assistant to help you create commits following the standard
|
|
10
|
+
- **GitLens**: Advanced Git visualization
|
|
11
|
+
- **Git Graph**: Graphical history view
|
|
12
12
|
|
|
13
13
|
### 2. Ways to Make Commits
|
|
14
14
|
|
|
@@ -35,10 +35,10 @@ git commit
|
|
|
35
35
|
|
|
36
36
|
#### Option 4: Via VS Code Snippets
|
|
37
37
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
38
|
+
- Type `cc-feat` + Tab for a new feature
|
|
39
|
+
- Type `cc-fix` + Tab for a bug fix
|
|
40
|
+
- Type `cc-docs` + Tab for documentation
|
|
41
|
+
- And so on...
|
|
42
42
|
|
|
43
43
|
### 3. Available Commit Types
|
|
44
44
|
|
|
@@ -91,9 +91,9 @@ an object with data instead of a direct array.
|
|
|
91
91
|
|
|
92
92
|
The project is set up with:
|
|
93
93
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
94
|
+
- ✅ **Husky**: Git hooks
|
|
95
|
+
- ✅ **CommitLint**: Commit message validation
|
|
96
|
+
- ✅ **Lint-staged**: Linting only modified files
|
|
97
97
|
|
|
98
98
|
### 7. Useful Commands
|
|
99
99
|
|
|
@@ -115,10 +115,10 @@ npm run release
|
|
|
115
115
|
|
|
116
116
|
Settings are located in `.vscode/settings.json`:
|
|
117
117
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
118
|
+
- Message validation enabled
|
|
119
|
+
- Predefined scopes for the project
|
|
120
|
+
- Character limit configured
|
|
121
|
+
- Integrated terminal setup
|
|
122
122
|
|
|
123
123
|
## Key Tips
|
|
124
124
|
|