OpenAPITools / OpenAPITools/openapi-generator

[Potential documentation improvement] Github integration

Open
#8,785 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Announcement
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

I've taken a look at the available Github integration docs here and it currently contains what looks like a client side codegen and git push to Github type of workflow.

This doesn't quite fit the workflow that I'm going for which is -> iterative development of api spec, iterative push api spec to github and have github automatically perform codegen from the api spec upon api spec update.

Perhaps this is more in the realm of CI/CD than what the current docs offer for Github..anyway I've built a working example here within a Github action: https://github.com/jjssoftware/go-user-api/blob/master/.github/workflows/workflow_actions.yml

I'll happily create a PR on https://github.com/OpenAPITools/openapi-generator/blob/master/docs/integration.md if we think it will be of general use to people.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/integration.md and compare its current GitHub workflow with the example in .github/workflows/workflow_actions.yml. Document the iterative API-spec push and GitHub Actions code-generation workflow, ensuring the example link and described steps are clear and useful.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, github-actions
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.