Skip to content

Commit c18b287

Browse files
committed
docs: Replace GitLab CI with GitHub Actions examples
- Remove GitLab CI example - Add basic GitHub Actions example - Add advanced GitHub Actions example with custom structures and step summary - Focus documentation on GitHub Actions as the primary CI/CD platform
1 parent 2de00e1 commit c18b287

1 file changed

Lines changed: 44 additions & 15 deletions

File tree

docs/environment-variables.md

Lines changed: 44 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,8 @@ services:
200200
201201
## CI/CD Pipeline Integration
202202
203-
**GitHub Actions Example:**
203+
### GitHub Actions - Basic Example
204+
204205
```yaml
205206
name: Generate Project Structure
206207

@@ -229,21 +230,49 @@ jobs:
229230
path: generated-project/
230231
```
231232
232-
**GitLab CI Example:**
233+
### GitHub Actions - Advanced Example with Custom Structures
234+
233235
```yaml
234-
generate_structure:
235-
image: python:3.11
236-
script:
237-
- pip install structkit
238-
- structkit generate my-structure ./output
239-
artifacts:
240-
paths:
241-
- output/
242-
only:
243-
- main
244-
variables:
245-
STRUCTKIT_NON_INTERACTIVE: "true"
246-
STRUCTKIT_FILE_STRATEGY: "backup"
236+
name: Generate with Custom Structures
237+
238+
on:
239+
push:
240+
branches: [main, develop]
241+
pull_request:
242+
branches: [main]
243+
244+
jobs:
245+
generate:
246+
runs-on: ubuntu-latest
247+
env:
248+
STRUCTKIT_NON_INTERACTIVE: "true"
249+
STRUCTKIT_LOG_LEVEL: DEBUG
250+
STRUCTKIT_OUTPUT_MODE: console
251+
steps:
252+
- uses: actions/checkout@v3
253+
254+
- name: Set up Python
255+
uses: actions/setup-python@v4
256+
with:
257+
python-version: '3.11'
258+
259+
- name: Install StructKit
260+
run: pip install structkit
261+
262+
- name: Generate default structure
263+
run: structkit generate python-basic ./my-project
264+
265+
- name: Generate with custom backup strategy
266+
env:
267+
STRUCTKIT_BACKUP_PATH: ./backups
268+
STRUCTKIT_FILE_STRATEGY: backup
269+
run: structkit generate terraform-module ./my-infrastructure
270+
271+
- name: Create summary
272+
run: |
273+
echo "## Generated Structures" >> $GITHUB_STEP_SUMMARY
274+
echo "- Python project generated" >> $GITHUB_STEP_SUMMARY
275+
echo "- Terraform module generated" >> $GITHUB_STEP_SUMMARY
247276
```
248277
249278
## Best Practices

0 commit comments

Comments
 (0)