Cursor rule

1---
2description: 
3globs: .github/workflows/*.yml
4alwaysApply: false
5---
6 # GitHub Actions Standards
7 
8Ensures GitHub Actions workflows follow best practices and use the latest action versions.
9 
10## Rule Details
11 
12- **Name:** github_actions_standards
13 
14- **Description:** Enforce standards for GitHub Actions workflows
15 
16## Filters
17- file extension pattern: `\\.ya?ml$`
18- file path pattern: `\\.github/workflows/`
19 
20## Enforcement Checks
21- Conditions:
22  - pattern `uses:\\s*actions/upload-artifact@v[123]` – Use actions/upload-artifact@v4 instead of older versions. Version 3 is deprecated: https://github.blog/changelog/2024-04-16-deprecation-notice-v3-of-the-artifact-actions/
23  - pattern `uses:\\s*actions/download-artifact@v[123]` – Use actions/download-artifact@v4 instead of older versions.
24  - pattern `uses:\\s*actions/checkout@v[12]` – Consider using actions/checkout@v4 for the latest features and security updates.
25 
26## Suggestions
27- Guidance:
28**GitHub Actions Best Practices:**
29- **Latest Action Versions:** Always use the latest stable versions of GitHub Actions.
30  - `actions/checkout@v4`
31  - `actions/upload-artifact@v4`
32  - `actions/download-artifact@v4`
33  - `actions/setup-node@v4`
34  - `actions/setup-python@v5`
35- **Workflow Structure:** Organize workflows with clear job names and step descriptions.
36- **Caching:** Implement caching for dependencies to speed up workflows.
37- **Security:** Use `GITHUB_TOKEN` with minimum required permissions.
38- **Artifacts:** Use descriptive names for artifacts and set appropriate retention periods.
39- **Matrix Strategy:** Use matrix builds for testing across multiple environments.
40- **Timeouts:** Set appropriate timeouts for jobs to prevent hanging workflows.
41 
42## Validation Checks
43- Conditions:
44  - pattern `uses:\\s*actions/upload-artifact@v4` – Good job using the latest version of actions/upload-artifact!
45  - pattern `uses:\\s*actions/download-artifact@v4` – Good job using the latest version of actions/download-artifact!
46  - pattern `uses:\\s*actions/checkout@v[34]` – Good job using a recent version of actions/checkout!
47 
48## Metadata
49- Priority: high
50- Version: 1.1
51- Tags: ci/cd, github, automation
52