Skip to content

[Documentation] Add instructions to build the javascript client module #2806

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

Merged
merged 2 commits into from
May 5, 2019
Merged

Conversation

jdorel
Copy link
Contributor

@jdorel jdorel commented May 3, 2019

PR checklist

I am not sure the unchecked box apply for documentation, please correct me if I am wrong.

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

This is a simple documentation PR to add the npm run build in the documentation (which was not required previously.

@jdorel jdorel changed the title [Documentation] Add instructions to build the module [Documentation] Add instructions to build the javascript client module May 3, 2019
@wing328 wing328 added this to the 4.0.0 milestone May 3, 2019
@karismann
Copy link
Contributor

@jdorel thanks for the PR, may i ask you to locally run ./bin/javascript-petstore-all.sh to commit the update samples with your changes ?

@jdorel
Copy link
Contributor Author

jdorel commented May 3, 2019

I ran the ./bin/javascript-petstore-all.sh, but nothing was modified. Here is the result: https://pastebin.com/raw/gaDtnUt4

@wing328
Copy link
Member

wing328 commented May 3, 2019

@jdorel did you run mvn clean package -DskipTests first before updating the samples?

@jdorel
Copy link
Contributor Author

jdorel commented May 3, 2019

My bad, I forgot to git checkout ... 🤦

PS: Is the mvn clean package -DskipTests required ? If so should it be in the contributions guidelines / PR template ?

@jimschubert
Copy link
Member

I've made a clarification to the PR template via #2819.

@wing328 wing328 merged commit f2f12b9 into OpenAPITools:master May 5, 2019
@jdorel jdorel deleted the patch-1 branch May 5, 2019 09:40
jimschubert added a commit that referenced this pull request May 5, 2019
* master:
  resize lightbow logo
  add lightbow logo
  add Lightbow as sponsor (#2822)
  [docs] Document new templating engine, adding ability to reference templates by file to comlete the example (#2773)
  [JAVA][KOTLIN] fix var Naming for all uppercase with Numbers (#2794)
  [Documentation] Add instructions to build the javascript client module (#2806)
  use mvn instead of run-in-docker (#2821)
  Better handling of form data (#2818)
  [haskell-servant] Add some missing types to the generated modules (#2675)
jimschubert added a commit that referenced this pull request May 5, 2019
* master:
  resize lightbow logo
  add lightbow logo
  add Lightbow as sponsor (#2822)
  [docs] Document new templating engine, adding ability to reference templates by file to comlete the example (#2773)
  [JAVA][KOTLIN] fix var Naming for all uppercase with Numbers (#2794)
  [Documentation] Add instructions to build the javascript client module (#2806)
  use mvn instead of run-in-docker (#2821)
  Better handling of form data (#2818)
  [haskell-servant] Add some missing types to the generated modules (#2675)
  Clarifies need to build project for sample output (#2819)
  [Elm] Bugfix .encode in modelTypeDiscriminator (#2807)
  Apply strict spec option to CodegenConfig instance (#2814)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants