Skip to content

Conversation

@hdamker-bot
Copy link
Contributor

CAMARA Project Admin Update - Linting Setup

This pull request adds centralized linting workflows to ensure code quality and API specification compliance.

✅ Added Workflows

  • spectral-oas-caller.yml - Spectral linting with CAMARA ruleset for OpenAPI validation
  • pr_validation_caller.yml - Comprehensive PR validation checks

✨ Benefits

  1. Automated Quality Checks: Ensures API specifications meet CAMARA standards
  2. PR Validation: Automatic checks on all pull requests
  3. Always Current: Workflows reference centralized tooling for latest updates
  4. Zero Maintenance: No local configuration needed

📋 What This Means for You

  • Automated validation on all pull requests to main branch
  • Immediate feedback on API specification compliance
  • No local setup required - everything is managed centrally

🔧 Technical Details

The new workflows reference reusable workflows from:
camaraproject/tooling/.github/workflows/

This ensures all repositories benefit from:

  • Latest Spectral rules for OpenAPI validation
  • Consistent PR validation checks
  • Centralized rule management
  • Automated tooling updates

👥 Next Steps for Codeowners

⚠️ Since this repository had no prior linting, there may be existing issues to address.

⚠️ Important: This PR introduces linting workflows that will validate repository content.

Note on Linting Checks: The linting workflows are currently not blocking - they will not prevent this PR (or future PRs) from being merged. However, it is highly recommended to:

  • Fix all linting errors before merging
  • Establish a practice of only merging PRs that pass linting checks successfully
  • All linting errors must be addressed before creating a release

This approach maintains code quality while allowing flexibility during the transition period.

Before Merging This PR:

  1. Review linting results in PR checks:

    • Check the "Checks" tab for workflow results
    • Note any linting errors or warnings reported
  2. Fix linting errors (strongly recommended):

    • Address all OpenAPI specification issues (Spectral and yamllint errors)
    • Address all test definitions issues (gherkin-lint errors)
    • Push fixes to this PR branch to re-trigger validation
    • While not required for merge, fixing issues now prevents accumulation of technical debt
  3. Approve and merge this PR 🚀

After Merge:

  1. Establish linting best practices:

    • Although checks are not blocking, treat linting errors as issues to fix
    • Aim to merge only PRs where linting checks pass successfully
    • This maintains code quality standards and prevents regression
    • Remember: Linting errors must be fixed before any release can be created
  2. Test with additional rules (optional):

    • Verify OpenAPI specification with lower severity rules (warnings, hints, info)
    • Go to Actions tab → "Caller for Spectral linting with CAMARA ruleset" → Run workflow
    • Check workflow logs - if needed create an issue to improve your API specification
  3. Monitor future PRs:

    • Provide guidance to contributors on fixing linting issues
    • First PRs after this may reveal new edge cases
    • The Release Management team can assist with complex issues

💡Pro tip: Running the Spectral workflow manually NOW is highly recommended. This allows you to identify and fix issues proactively rather than discovering them when submitting your next feature PR!


🤖 Generated via project-admin workflow
Triggered by hdamker, executed via hdamker-bot

➡️ Next Steps: This PR should be reviewed, fixed as needed, approved, and merged by repository codeowners following standard review processes.


This is a manually triggered automated administrative update.

Applied via project-admin workflow
Repository: ClickToDial
Operation: centralize-linting-workflows
@github-actions
Copy link

github-actions bot commented Oct 15, 2025

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.01s
✅ API spectral 1 0 1.72s
✅ GHERKIN gherkin-lint 3 0 1.07s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY secretlint yes no 0.72s
✅ YAML yamllint 1 0 0.47s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

Copy link
Contributor

@YadingFang YadingFang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Split event notification scenario and shorten payload checks.

@YadingFang YadingFang merged commit b929300 into main Dec 11, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants