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

MODSER-22: Add API documentation workflows #81

Merged
merged 5 commits into from
Mar 8, 2024

Conversation

ostephens
Copy link
Contributor

No description provided.

@ostephens ostephens changed the title Add API documentation workflows MODSER-22: Add API documentation workflows Mar 7, 2024
@ostephens ostephens marked this pull request as ready for review March 7, 2024 10:40
@dcrossleyau
Copy link

Needs a inconsequential commit to the openapi/serials-management.yaml to trigger the worrkflow runs.

@dcrossleyau
Copy link

The "paths" are incorrect in each of the workflows. Need to be 'openapi/**'

Refer to the help comments at the head of the workflow files.

@dcrossleyau
Copy link

The Action 'uses: actions/checkout@v3' is out-of-date. Should be v4

Keep synchronised with the templates at https://github.com/folio-org/.github/tree/master/workflow-templates

@ostephens
Copy link
Contributor Author

Thanks for guidance @dcrossleyau . Have made sure these are up to date with the templates with the correct paths

@dcrossleyau
Copy link

I suggest that you add a blank line to the end of openapi/serials-management.yaml file to trigger the initial workflow runs before merging.

@ostephens
Copy link
Contributor Author

@dcrossleyau Thanks. I can see api-lint and api-schema-lint ran, but not api-doc. Is this expected or is there an obvious reason why?

@dcrossleyau
Copy link

Yes @ostephens that is correct, and goodness. As per the definitions in the api-doc.yml Workflow, it is only triggered on the merge to mainline branch or on release. Good to merge.

@dcrossleyau dcrossleyau self-requested a review March 8, 2024 10:10
@EthanFreestone EthanFreestone merged commit b95626b into folio-org:master Mar 8, 2024
5 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.

None yet

3 participants