[FOLIO-3203] Use Actions Workflow for api-doc Created: 15/Jun/21  Updated: 04/Jan/23  Resolved: 31/Aug/22

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: oas, raml
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-3678 Ensure API-related GitHub Workflows a... Closed
relates to FOLIO-3202 Use Actions Workflow for api-lint Closed
Sprint: DevOps Sprint 146, DevOps Sprint 144, DevOps Sprint 122, DevOps Sprint 145, DevOps Sprint 123, DevOps Sprint 124
Development Team: FOLIO DevOps

 Description   

Create a GithUb Actions Workflow for api-doc.

This is for back-end modules that utilise RAML or OpenAPI (OAS). It operates on merge to main branch and on a release. It does not operate on feature branches.

The tool is currently invoked via jenkins-pipeline-libs/vars/buildMvn.groovy at build stage "Generate API docs" calling "runApiDoc" and configured via each project repository Jenkinsfile "doApiDoc".

This worflow should depend on a successful run of the "api-lint" workflow ( FOLIO-3202 Closed ).

It publishes the generated files to AWS S3 at "foliodocs/api". There is an example of "Publish to S3" Action at the "gather-schema-changes" workflow ( FOLIO-2976 Closed ).



 Comments   
Comment by David Crossley [ 31/Aug/22 ]

Tested via mod-eusage-reports.

Added to .github/workflow-templates

Generated at Thu Feb 08 23:26:22 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.