Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Wiki
  • Samples folder

Samples folder · Changes

Page history
Updated Samples folder (markdown) authored Jul 30, 2018 by Jérémie Bresson's avatar Jérémie Bresson
Hide whitespace changes
Inline Side-by-side
Samples-folder.md
View page @ 64622b74
......@@ -5,9 +5,17 @@ Output: `samples/`
TODO:
* document and explain `samples.ci/`
* explain `ensure-up-to-date` script [#80](https://github.com/OpenAPITools/openapi-generator/issues/80)
### samples.ci folder
In an ideal world, we consider that contributors always can remove a specific output in the `samples/` folder and re-generate it from the corresponding `bin/*.sh` script.
This is not always the case, as our CI-Jobs sometimes need additional items that are not generated by the generator. For example maven is used to orchestrate the execution of the tests in each samples. As a consequence, a `pom.xml` file is requested in the generated sample. The generator does not create it, because this is uncommon to use maven to compile and test a sample in an other language (ruby, typescript, ...).
The idea to solve this project is to have an other folder [`samples.ci/`](https://github.com/OpenAPITools/openapi-generator/tree/master/CI/samples.ci) that contains the manually written items that are copied to the `samples/` folder after generation of the example project.
## Scripts
Table to find the script corresponding to an output folder in the `samples/` folder (this help to (re)generate one of the example):
......
Clone repository
  • API client generator HOWTO
  • Building your own Templates
  • Customizing client code generation
  • FAQ
  • Git Branches
  • Home
  • How to add a generator for a new language or framework
  • Integration Tests
  • Migration Guide
  • Mustache Template Variables
  • Pull Request Checklist
  • Release Checklist
  • Samples folder
  • Server stub generator HOWTO
  • Vendor Extensions
View All Pages