forked from loafle/openapi-generator-original
Deploy website
Deploy website version based on 9c6b94c29246b6c94ce86a4a5d8e523a395afdae
This commit is contained in:
wing328
parent
e6ebd239c7
commit
290cc33b86
@ -133,7 +133,7 @@
|
||||
<p>To add test cases (optional) covering the change in the code generator, please refer to <a href="https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/test/java/org/openapitools/codegen">modules/openapi-generator/src/test/java/org/openapitools/codegen</a></p>
|
||||
<p>To test the templates, please perform the following:</p>
|
||||
<ul>
|
||||
<li>Update the Petstore sample by running the shell scripts under <code>bin</code> and <code>bin/openapi3</code> folder. For example, run <code>./bin/python-client-petstore.sh</code> and <code>./bin/openapi3/python-client-petstore.sh</code> to update the Python PetStore API client under <a href="https://github.com/openapitools/openapi-generator/tree/master/samples/client/petstore/python"><code>samples/client/petstore/python</code></a> and <a href="https://github.com/openapitools/openapi-generator/tree/master/samples/openapi3/client/petstore/python"><code>samples/openapi3/client/petstore/python</code></a>. For Windows, the batch files can be found under <code>bin\windows</code> folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion)</li>
|
||||
<li>Update the Petstore sample by running the shell scripts under <code>bin</code> and <code>bin/openapi3</code> folder. For example, run <code>./bin/python-petstore.sh</code> and <code>./bin/openapi3/python-petstore.sh</code> to update the Python PetStore API client under <a href="https://github.com/openapitools/openapi-generator/tree/master/samples/client/petstore/python"><code>samples/client/petstore/python</code></a> and <a href="https://github.com/openapitools/openapi-generator/tree/master/samples/openapi3/client/petstore/python"><code>samples/openapi3/client/petstore/python</code></a>. For Windows, the batch files can be found under <code>bin\windows</code> folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion)</li>
|
||||
<li>Run the tests in the sample folder using maven <code>mvn integration-test -rf :<artifactId></code>, e.g. open a shell in <code>samples/client/petstore/python</code>, run <code>mvn integration-test -rf :PythonPetstoreClientTests</code>. The artifactId of the project can be found in the pom.xml file. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests)</li>
|
||||
<li>Finally, git commit the updated samples files: <code>git commit -a</code>
|
||||
(<code>git add -A</code> if added files with new test cases)</li>
|
||||
@ -154,4 +154,4 @@
|
||||
</ul></li>
|
||||
<li>To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. <code>fix #1542</code>. (Ref: <a href="https://help.github.com/articles/closing-issues-using-keywords/">closing issues using keywords</a>)</li>
|
||||
</ul>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-10-5</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/integrations"><span class="arrow-prev">← </span><span>Workflow Integrations</span></a><a class="docs-next button" href="/docs/code-of-conduct"><span>Code of Conduct</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#before-submitting-an-issue">Before submitting an issue</a></li><li><a href="#before-submitting-a-pr">Before submitting a PR</a></li><li><a href="#how-to-contribute">How to contribute</a><ul class="toc-headings"><li><a href="#git">git</a></li><li><a href="#branches">Branches</a></li><li><a href="#code-generators">Code generators</a></li><li><a href="#templates">Templates</a></li><li><a href="#style-guide">Style guide</a></li><li><a href="#testing">Testing</a></li><li><a href="#tips">Tips</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-10-14</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/integrations"><span class="arrow-prev">← </span><span>Workflow Integrations</span></a><a class="docs-next button" href="/docs/code-of-conduct"><span>Code of Conduct</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#before-submitting-an-issue">Before submitting an issue</a></li><li><a href="#before-submitting-a-pr">Before submitting a PR</a></li><li><a href="#how-to-contribute">How to contribute</a><ul class="toc-headings"><li><a href="#git">git</a></li><li><a href="#branches">Branches</a></li><li><a href="#code-generators">Code generators</a></li><li><a href="#templates">Templates</a></li><li><a href="#style-guide">Style guide</a></li><li><a href="#testing">Testing</a></li><li><a href="#tips">Tips</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
@ -133,7 +133,7 @@
|
||||
<p>To add test cases (optional) covering the change in the code generator, please refer to <a href="https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/test/java/org/openapitools/codegen">modules/openapi-generator/src/test/java/org/openapitools/codegen</a></p>
|
||||
<p>To test the templates, please perform the following:</p>
|
||||
<ul>
|
||||
<li>Update the Petstore sample by running the shell scripts under <code>bin</code> and <code>bin/openapi3</code> folder. For example, run <code>./bin/python-client-petstore.sh</code> and <code>./bin/openapi3/python-client-petstore.sh</code> to update the Python PetStore API client under <a href="https://github.com/openapitools/openapi-generator/tree/master/samples/client/petstore/python"><code>samples/client/petstore/python</code></a> and <a href="https://github.com/openapitools/openapi-generator/tree/master/samples/openapi3/client/petstore/python"><code>samples/openapi3/client/petstore/python</code></a>. For Windows, the batch files can be found under <code>bin\windows</code> folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion)</li>
|
||||
<li>Update the Petstore sample by running the shell scripts under <code>bin</code> and <code>bin/openapi3</code> folder. For example, run <code>./bin/python-petstore.sh</code> and <code>./bin/openapi3/python-petstore.sh</code> to update the Python PetStore API client under <a href="https://github.com/openapitools/openapi-generator/tree/master/samples/client/petstore/python"><code>samples/client/petstore/python</code></a> and <a href="https://github.com/openapitools/openapi-generator/tree/master/samples/openapi3/client/petstore/python"><code>samples/openapi3/client/petstore/python</code></a>. For Windows, the batch files can be found under <code>bin\windows</code> folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI spec from time to time. If you've questions or concerns, please open a ticket to start a discussion)</li>
|
||||
<li>Run the tests in the sample folder using maven <code>mvn integration-test -rf :<artifactId></code>, e.g. open a shell in <code>samples/client/petstore/python</code>, run <code>mvn integration-test -rf :PythonPetstoreClientTests</code>. The artifactId of the project can be found in the pom.xml file. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests)</li>
|
||||
<li>Finally, git commit the updated samples files: <code>git commit -a</code>
|
||||
(<code>git add -A</code> if added files with new test cases)</li>
|
||||
@ -154,4 +154,4 @@
|
||||
</ul></li>
|
||||
<li>To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. <code>fix #1542</code>. (Ref: <a href="https://help.github.com/articles/closing-issues-using-keywords/">closing issues using keywords</a>)</li>
|
||||
</ul>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-10-5</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/integrations"><span class="arrow-prev">← </span><span>Workflow Integrations</span></a><a class="docs-next button" href="/docs/code-of-conduct"><span>Code of Conduct</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#before-submitting-an-issue">Before submitting an issue</a></li><li><a href="#before-submitting-a-pr">Before submitting a PR</a></li><li><a href="#how-to-contribute">How to contribute</a><ul class="toc-headings"><li><a href="#git">git</a></li><li><a href="#branches">Branches</a></li><li><a href="#code-generators">Code generators</a></li><li><a href="#templates">Templates</a></li><li><a href="#style-guide">Style guide</a></li><li><a href="#testing">Testing</a></li><li><a href="#tips">Tips</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-10-14</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/integrations"><span class="arrow-prev">← </span><span>Workflow Integrations</span></a><a class="docs-next button" href="/docs/code-of-conduct"><span>Code of Conduct</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#before-submitting-an-issue">Before submitting an issue</a></li><li><a href="#before-submitting-a-pr">Before submitting a PR</a></li><li><a href="#how-to-contribute">How to contribute</a><ul class="toc-headings"><li><a href="#git">git</a></li><li><a href="#branches">Branches</a></li><li><a href="#code-generators">Code generators</a></li><li><a href="#templates">Templates</a></li><li><a href="#style-guide">Style guide</a></li><li><a href="#testing">Testing</a></li><li><a href="#tips">Tips</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
Loading…
x
Reference in New Issue
Block a user