Skip to content

Commit d261b8c

Browse files
committed
docs: add agent workflow for CI/CD pipelines
1 parent db3234a commit d261b8c

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

.agent/workflows/ci.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
description: How to manage and monitor GitHub Actions CI/CD workflows
3+
---
4+
5+
// turbo-all
6+
# CI/CD Workflows Management
7+
8+
This workflow covers the automated pipelines defined in `.github/workflows/`.
9+
10+
## Core Pipelines
11+
12+
### 1. Rust CI (`rust.yml`)
13+
- **Purpose**: Runs on every push and PR to main branches.
14+
- **Actions**:
15+
- `cargo fmt`: Checks code formatting.
16+
- `cargo clippy`: Runs linting with strict warnings.
17+
- `cargo test`: Executes unit and integration tests across Ubuntu, macOS, and Windows.
18+
19+
### 2. VS Code Extension (`vscode-extension.yml`)
20+
- **Purpose**: Automates the building, packaging, and publishing of the VS Code extension.
21+
- **Actions**:
22+
- Builds bundled binaries for multiple platforms (Linux, Windows, macOS x64/arm64).
23+
- Packages the `.vsix` extension.
24+
- Publishes to VS Code Marketplace and Open VSX when a version tag (e.g., `v*`) is pushed.
25+
26+
### 3. Release Automation (`release-plz.yml` / `release.yml`)
27+
- **Purpose**: Manages crate releases and automated changelog generation using `release-plz`.
28+
29+
## Monitoring and Debugging
30+
31+
1. **Check Status**:
32+
View the **Actions** tab on GitHub to see the status of all runs.
33+
34+
2. **Local Linting (Pre-commit)**:
35+
It is recommended to run these commands before pushing to avoid CI failures:
36+
`cargo fmt --all`
37+
`cargo clippy --all-targets --all-features -- -D warnings`
38+
`cargo test`
39+
40+
3. **Manual Trigger**:
41+
The `VS Code Extension` workflow can be triggered manually via `workflow_dispatch` if needed.

0 commit comments

Comments
 (0)