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

[DOC] Add link to integration test wiki in CONTRIBUTING.md #5570

Merged
merged 2 commits into from Mar 10, 2020

Conversation

@sebastien-rosset
Copy link
Contributor

sebastien-rosset commented Mar 9, 2020

Adding a link to the integration test page in the wiki.

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
@sebastien-rosset

This comment has been minimized.

Copy link
Contributor Author

sebastien-rosset commented Mar 9, 2020

@wing328

This comment has been minimized.

Copy link
Member

wing328 commented Mar 10, 2020

--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -95,7 +95,12 @@ To test the templates, please perform the following:
   (`git add -A` if added files with new test cases)
 - For new test cases, please add to the [Fake Petstore spec](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml)
 
-To start the CI tests, you can run `mvn verify -Psamples` (assuming you've all the required tools installed to run tests for different languages) or you can leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository.
+To start the CI tests, you can:
+- Run `mvn verify -Psamples`, assuming you have all the required tools installed to run tests for different languages.
+- Leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository.
+- Run some of the CI tests in your local workspace.
+
+See [OpenAPI Tools wiki](https://github.com/OpenAPITools/openapi-generator/wiki/Integration-Tests) for more information about the integration tests.
 
 ### Tips
 - Smaller changes are easier to review
Perform git status
On branch pull/5570
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   docs/contributing.md

no changes added to commit (use "git add" and/or "git commit -a")
Please run 'bin/utils/ensure-up-to-date' locally and commit changes (UNCOMMITTED CHANGES ERROR)

I'll update the doc in a separate commit.

@wing328 wing328 merged commit ce8cdcd into OpenAPITools:master Mar 10, 2020
4 of 6 checks passed
4 of 6 checks passed
ci/bitrise/4a2b10a819d12b67/pr Failed - openapi-generator
Details
ci/circleci: build Your tests failed on CircleCI
Details
Shippable Run 15524 status is SUCCESS.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/drone/pr Build is passing
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@wing328 wing328 added this to the 4.3.0 milestone Mar 10, 2020
@sebastien-rosset

This comment has been minimized.

Copy link
Contributor Author

sebastien-rosset commented Mar 10, 2020

thank you!

MikailBag added a commit to MikailBag/openapi-generator that referenced this pull request Mar 23, 2020
…ols#5570)

* Add link to integration test wiki

* Add link to integration test wiki
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.