Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplification/automation of linting ruleset updates in CAMARA repositories #263

Open
rartych opened this issue Jul 31, 2024 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@rartych
Copy link
Collaborator

rartych commented Jul 31, 2024

Problem description
Currently linting rules are executed as Github Actions with workflows defined in each API repository. When workflows need to be modified (due to changes in guidelines or ruleset, updates of tools used in workflows, etc.) the changes have to be introduced with separated PRs in every repository.

Possible evolution
Reusable workflows feature of Github can be used to avoid this tedious task.
To make it work we need to:

  • create reusable workflows in dedicated CAMARA repository called for example Linting,
  • replace currently defined workflows with caller workflows using reusable workflows.

Then reusable workflows can be then updated once, and caller workflows will use the latest version when triggered in the respective API repository.

It might be useful to have model CAMARA API repository, that includes example API definition and all needed artifacts (workflows, user stories, test definitions, etc>) - something like Swagger Petstore. Should we call it Model_API_Repository?
It can serve as example for new CAMARA participants and new API definitions. It can be used to test reusable workflows and demonstrate how to call them. In the next step the workflows for API specification bundling using common components can be developed in this repository.

The additional effort to maintain the repository and keep it updated is obviously needed.

Alternative solution
Other multi-repository automation solutions.

Additional context
The volunteers from Commonalities WG for codeowners and maintainers of described repositories would be needed.

@rartych rartych added the enhancement New feature or request label Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant