Skip to content

Commit 27210e3

Browse files
Remove all emojis from run tasks integration documentation
1 parent 35d2296 commit 27210e3

1 file changed

Lines changed: 33 additions & 33 deletions

File tree

docs/RUN_TASKS_INTEGRATION_EXAMPLE.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,13 @@ client.run_tasks_integration.callback(
9090

9191
### Step 7: TFC/TFE Receives and Displays Results
9292
In the TFC/TFE UI, users see:
93-
- **Run Task Status**: Passed or Failed
94-
- 📝 **Message**: Your custom message
95-
- 📊 **Outcomes**: Detailed results with tags
96-
- 🔗 **Link**: To your detailed results page
93+
- **Run Task Status**: Passed or Failed
94+
- **Message**: Your custom message
95+
- **Outcomes**: Detailed results with tags
96+
- **Link**: To your detailed results page
9797

98-
If mandatory and failed → Run is blocked
99-
If advisory and failed → Run continues with warning ⚠️
98+
If mandatory and failed → Run is blocked
99+
If advisory and failed → Run continues with warning
100100

101101
---
102102

@@ -149,31 +149,31 @@ if not meets_compliance_standards(config):
149149

150150
The example file shows you how to:
151151

152-
**Receive webhooks** from TFC/TFE using a simple HTTP server
153-
**Parse `RunTaskRequest`** - the webhook payload from TFC/TFE
154-
**Access run information** - workspace, organization, stage, run ID
155-
**Add custom validation logic** - where you insert your checks
156-
**Create detailed outcomes** - with descriptions, tags, and links
157-
**Send results back** - using the `callback()` method
158-
**Handle errors gracefully** - proper error handling and responses
152+
- **Receive webhooks** from TFC/TFE using a simple HTTP server
153+
- **Parse `RunTaskRequest`** - the webhook payload from TFC/TFE
154+
- **Access run information** - workspace, organization, stage, run ID
155+
- **Add custom validation logic** - where you insert your checks
156+
- **Create detailed outcomes** - with descriptions, tags, and links
157+
- **Send results back** - using the `callback()` method
158+
- **Handle errors gracefully** - proper error handling and responses
159159

160160
---
161161

162162
## Why This Example is Important
163163

164164
### Without Run Tasks Integration:
165-
- Manual code reviews for every change
166-
- Inconsistent policy enforcement
167-
- Security issues discovered after deployment
168-
- Cost overruns without warnings
165+
- Manual code reviews for every change
166+
- Inconsistent policy enforcement
167+
- Security issues discovered after deployment
168+
- Cost overruns without warnings
169169

170170
### With Run Tasks Integration:
171-
- Automated validation before apply
172-
- Consistent policy enforcement
173-
- Security issues caught early
174-
- Cost controls built into workflow
175-
- Detailed audit trail
176-
- Custom business logic enforcement
171+
- Automated validation before apply
172+
- Consistent policy enforcement
173+
- Security issues caught early
174+
- Cost controls built into workflow
175+
- Detailed audit trail
176+
- Custom business logic enforcement
177177

178178
---
179179

@@ -250,22 +250,22 @@ Sends results back to TFC/TFE:
250250

251251
## Testing Strategy
252252

253-
### Level 1: Unit Tests
253+
### Level 1: Unit Tests
254254
```bash
255255
pytest tests/units/test_run_tasks_integration.py
256256
```
257257
Tests parsing and validation logic.
258258

259-
### Level 2: Local Integration
259+
### Level 2: Local Integration
260260
```bash
261261
python test_run_tasks_local.py
262262
```
263263
Simulates complete flow with mock TFC/TFE server.
264264

265-
### Level 3: Cloud Deployment
265+
### Level 3: Cloud Deployment
266266
Deploy to EC2/cloud and test with real webhooks.
267267

268-
### Level 4: Real HCP Terraform
268+
### Level 4: Real HCP Terraform
269269
Configure in actual TFC/TFE and trigger real runs.
270270

271271
---
@@ -286,11 +286,11 @@ Configure in actual TFC/TFE and trigger real runs.
286286

287287
## Next Steps
288288

289-
1. Review the example code
290-
2. Test locally with `test_run_tasks_local.py`
291-
3. Customize validation logic for your needs
292-
4. Deploy to cloud server
293-
5. Configure in TFC/TFE
294-
6. Monitor and iterate
289+
1. Review the example code
290+
2. Test locally with `test_run_tasks_local.py`
291+
3. Customize validation logic for your needs
292+
4. Deploy to cloud server
293+
5. Configure in TFC/TFE
294+
6. Monitor and iterate
295295

296296
**The example gives you everything you need to build your own run tasks integration!**

0 commit comments

Comments
 (0)