Skip to content

Commit abd2249

Browse files
authored
Merge pull request #30 from hdamker/add-linting-workflows
Linting workflows added
2 parents 025b6f2 + a934c6a commit abd2249

2 files changed

Lines changed: 91 additions & 0 deletions

File tree

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# =========================================================================================
2+
# CAMARA Project - Pull Request Validation Workflow Caller
3+
#
4+
# This GitHub Actions workflow is responsible for invoking a reusable PR validation workflow
5+
# from the camaraproject/tooling repository. It is intended to ensure consistent validation
6+
# steps for all PRs targeting the main branch in this repository.
7+
#
8+
# CHANGELOG:
9+
# - 2025-08-01: Initial version for v0
10+
#
11+
# USAGE:
12+
# - Automatically triggers on pull requests targeting main.
13+
# - Can be triggered manually via workflow_dispatch.
14+
# - Calls by default the reusable workflow at
15+
# camaraproject/tooling/.github/workflows/pr_validation.yml@v0
16+
#
17+
# DOCUMENTATION:
18+
# see https://github.com/camaraproject/tooling/tree/main/linting/docs
19+
# =========================================================================================
20+
21+
name: Caller for PR validation workflow
22+
23+
on:
24+
# Trigger on pull requests to the main branch only
25+
pull_request:
26+
branches: main
27+
# Enable manual trigger via the GitHub UI
28+
workflow_dispatch:
29+
30+
concurrency:
31+
group: ${{ github.ref }}-${{ github.workflow }}
32+
cancel-in-progress: true
33+
34+
permissions:
35+
# Grant necessary write permissions for PRs, contents, and issues
36+
pull-requests: write
37+
contents: write
38+
issues: write
39+
statuses: write
40+
41+
jobs:
42+
pr_validation:
43+
# Invoke the reusable PR validation workflow from "v0" tag of camaraproject/tooling
44+
uses: camaraproject/tooling/.github/workflows/pr_validation.yml@v0
45+
secrets: inherit
46+
# Tools configuration from the tooling repository subfolder of /linting/config/ indicated by `configurations` variable
47+
# If needed, you can specify a configuration from another subfolder of camaraproject/tooling/linting/config/ (uncomment below)
48+
# with:
49+
# configurations: api-name
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# =========================================================================================
2+
# CAMARA Project - Linting OpenAPI Specification with CAMARA Ruleset Caller
3+
#
4+
# This GitHub Actions workflow is responsible for invoking a reusable "Spectral linting with
5+
# CAMARA ruleset" workflow from the camaraproject/tooling repository. It is intended to
6+
# provide more detailed output from Spectral tool (warnings, hints)
7+
#
8+
# CHANGELOG:
9+
# - 2025-08-01: Initial version for v0
10+
#
11+
# USAGE:
12+
# - Can be triggered manually via workflow_dispatch.
13+
# - Calls by default the reusable workflow at
14+
# camaraproject/tooling/.github/workflows/spectral-oas.yml@v0
15+
#
16+
# DOCUMENTATION:
17+
# see https://github.com/camaraproject/tooling/tree/main/linting/docs
18+
# =========================================================================================
19+
20+
name: Caller for Spectral linting with CAMARA ruleset
21+
22+
on:
23+
workflow_dispatch:
24+
25+
concurrency:
26+
group: ${{ github.ref }}-${{ github.workflow }}
27+
cancel-in-progress: true
28+
29+
permissions:
30+
# Grant necessary write permissions for PRs and issues
31+
pull-requests: write
32+
contents: read
33+
issues: write
34+
35+
jobs:
36+
spectral:
37+
# Invoke the reusable PR validation workflow from the main branch of camaraproject/tooling
38+
uses: camaraproject/tooling/.github/workflows/spectral-oas.yml@v0
39+
# Spectral configuration from the tooling repository subfolder of /linting/config/ indicated by `configurations` variable
40+
# If needed, you can specify a configuration from another subfolder of camaraproject/tooling/linting/config/ (uncomment below)
41+
# with:
42+
# configurations: api-name

0 commit comments

Comments
 (0)