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

MODLD-602 & FOLIO-3678: Use GitHub Workflows api-lint and api-schema-lint and api-doc #52

Merged
merged 2 commits into from
Nov 22, 2024

Conversation

pkjacob
Copy link
Contributor

@pkjacob pkjacob commented Nov 21, 2024

Making similar changes as in folio-org/mod-search#363

@dcrossleyau
Copy link

dcrossleyau commented Nov 21, 2024

The "API_EXCLUDES" is incorrect for both api-lint.yml and api-doc.yml -- it is "file name", so remove the path component. That exclusion is not needed in api-schema-lint.yml because it processes JSON files only.

I do not know anything about these modified Workflows that mod-search has made to the defaults linked from https://dev.folio.org/guides/api-doc/#github-workflows (i.e. those at https://github.com/folio-org/.github/tree/master/workflow-templates). So if there are issues then you will need assistance from them. Note that these mod-linked-data workflow files are not those that you say that you utilised from my original mod-search PR 363. Also i see that the "on ... paths" triggers have been removed.

Also remember that the main issue described at MODLD-602 (Invalid JSON pointer) will also arise here.

You should activate the workflows on this branch. With my original PR i did that via an inconsequential edit to an API description file. But that will be ineffective here because you have removed the triggers for api-lint and api-schema-lint Workflows.

@pkjacob
Copy link
Contributor Author

pkjacob commented Nov 21, 2024

Thank you for the feedback @dcrossleyau. I didn't realize that mod-search team deviated from the original templates in https://github.com/folio-org/.github/tree/master/workflow-templates. I have updated the PR to use the original templates. Please take a look.

I added an empty line in mod-linked-data.yml based on the following line in your comment. Is it really needed?

You should activate the workflows on this branch. With my original PR i did that via an inconsequential edit to an API description file.

Copy link

@dcrossleyau dcrossleyau left a comment

Choose a reason for hiding this comment

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

I see that the api-lint Workflow run was okay.

The api-doc Workflow will run when you merge to mainline.

@pkjacob pkjacob merged commit 1eb09ea into master Nov 22, 2024
8 checks passed
@julianladisch julianladisch deleted the pjacob/MODLD-602 branch November 23, 2024 18:04
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.

3 participants