Skip to content

admin: migrate to centralized linting workflows#66

Merged
Masa8106 merged 3 commits intomainfrom
camara-admin/centralize-linting-workflows-1755695497516
Aug 26, 2025
Merged

admin: migrate to centralized linting workflows#66
Masa8106 merged 3 commits intomainfrom
camara-admin/centralize-linting-workflows-1755695497516

Conversation

@hdamker-bot
Copy link
Contributor

CAMARA Project Admin Update - Linting Migration

This pull request migrates this repository from local linting configuration to centralized linting workflows managed by the CAMARA project.

🔄 Migration Summary

Removed local linting artifacts:

  • megalinter.yml
  • spectral_oas_lint.yml
  • .spectral.yml
  • .yamllint.yaml
  • Lint function scripts in /lint_function/

Added centralized workflows:

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

✨ Benefits of Centralized Linting

  1. Always Up-to-Date: Linting rules and workflows are automatically updated across all repositories
  2. Consistent Standards: Ensures uniform code quality checks across all CAMARA APIs
  3. Reduced Maintenance: No need to maintain linting configurations locally
  4. Enhanced Features: Access to latest tooling improvements without manual updates
  5. Simplified Configuration: Workflows reference the centralized tooling repository

📋 What This Means for You

  • No action required for basic operation - workflows will run automatically
  • All existing checks continue with improved reliability
  • Custom configurations can be discussed with the Release Management team if needed

🔧 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

⚠️ Important: This PR introduces linting workflows that will validate repository content. Linting errors will block this PR from merging until resolved.

Before This PR Can Be Merged:

  1. Review linting results in PR checks:

    • Check the "Checks" tab for workflow results
    • All linting errors must be resolved before merge is possible
  2. Fix linting errors directly in this PR:

    • 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
    • Repeat until all checks pass successfully

Approve and merge this PR 🚀

After Successful Merge:

  1. Monitor the new linting system:

    • All future PRs will be subject to the same linting requirements
    • Contributors will need to fix linting issues before their PRs can merge
    • This ensures code quality standards are maintained going forward
  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:

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

💡Pro tip: Running the Spectral workflow manually NOW is highly recommended. This allows you to 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: NumberRecycling
Operation: centralize-linting-workflows
@github-actions
Copy link

github-actions bot commented Aug 20, 2025

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.0s
✅ API spectral 1 0 1.43s
✅ GHERKIN gherkin-lint 1 0 0.31s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY secretlint yes no 0.65s
✅ YAML yamllint 1 0 0.35s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

…s-linting-errors

Update number-recycling.feature for PR66 linting errors
eric-murray
eric-murray previously approved these changes Aug 22, 2025
hdamker
hdamker previously approved these changes Aug 23, 2025
Copy link
Contributor

@hdamker hdamker left a comment

Choose a reason for hiding this comment

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

LGTM ... there is only one line which is not a whitespace change, and that looks correct.

@hdamker-bot hdamker-bot dismissed stale reviews from hdamker and eric-murray August 26, 2025 08:16

The merge-base changed after approval.

Masa8106
Masa8106 previously approved these changes Aug 26, 2025
Copy link
Contributor

@Masa8106 Masa8106 left a comment

Choose a reason for hiding this comment

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

LGTM, because of no error. Let me approve and merge this PR.

@hdamker-bot hdamker-bot dismissed Masa8106’s stale review August 26, 2025 08:23

The merge-base changed after approval.

@Masa8106
Copy link
Contributor

I wonder what blocked a merge of this PR...

eric-murray
eric-murray previously approved these changes Aug 26, 2025
@hdamker-bot hdamker-bot dismissed eric-murray’s stale review August 26, 2025 08:43

The merge-base changed after approval.

Rebase branch camara-admin/centralize-linting-workflows-1755695497516 to main
@eric-murray
Copy link
Contributor

@Masa8106

PR can be merged now. It required the admin branch to be re-based to main.

@Masa8106
Copy link
Contributor

Masa8106 commented Aug 26, 2025

@eric-murray , thank you so much! Please let me merge it.

@Masa8106 Masa8106 merged commit 0806ed4 into main Aug 26, 2025
2 checks passed
@eric-murray eric-murray deleted the camara-admin/centralize-linting-workflows-1755695497516 branch August 26, 2025 09:53
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