[FOLIO-3017] List RAML issues with migration to new CI tool api-lint Created: 16/Feb/21 Updated: 04/Oct/22 Resolved: 04/Oct/22 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Task | Priority: | TBD |
| Reporter: | David Crossley | Assignee: | David Crossley |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Issue links: |
|
||||||||||||||||
| Sprint: | |||||||||||||||||
| Development Team: | FOLIO DevOps | ||||||||||||||||
| Description |
|
The "api-lint" CI tool (
(This is the replacement for the now deprecated "lint-raml" runLintRamlCop tool.) Note that this api-lint tool is more thorough than our previous CI tool (based on raml-cop and its underlying outdated raml-1-parser). So projects might find new violations being reported. For projects that are not listed below, the replacement is straight-forward Jenkinsfile configuration. For some projects there are new issues being reported. The fixes should be easily handled. For a small set of projects, there are some issues which are more complex. These are either a real problem with the project's API description files, or are perhaps unidentified bugs with the underlying tool. If the latter, then please provide a basic test case which we can pass upstream (
Summary 2022-01-10 (using current amf-client-js v5.0.2): |
| Comments |
| Comment by David Crossley [ 16/Feb/21 ] |
|
Last updated: 2022-10-04 The label "OLD" means either that the project has now migrated to api-lint, or the violation has gone as api-lint has been upgraded to a new version of the underlying amf-client dependency (e.g. perhaps due to us providing an upsteam bug report), or that the project is still using the old deprecated lint-raml but have since modified their api description. For projects that are not on this list, there should be no issues encountered when upgrading (
Easily handled:
Known issue:
More complex or unidentified:
|