Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (33 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

45 lines (33 loc) · 2.19 KB

Contributing

Thank you so much for making the library better. Please feel free to open bug reports to discuss new features; PRs are welcome as well :)

Tests

Uses JUnit. Simply run ./gradlew test to run all tests.

There are system tests which run all apps and test that:

  1. The app is up and responds 200 OK on localhost:8080 with Vaadin index page
  2. The REST endpoints work correctly.
  3. The app shuts down cleanly via Enter.

To run the tests:

$ cd test && ./system.rb

Manual Tests

Make sure to test the Boot with all example apps, especially the Enter/CTRL+C handling:

  1. Run ./gradlew to clean up any Vaadin production build leftovers
  2. Run the Main class as a traditional main() from Intellij and test that Enter shuts down the app correctly.
  3. Run ./gradlew clean build testapp:run -Pvaadin.productionMode and test that CTRL+C kills the app
  4. Run ./gradlew clean build testapp-kotlin:run -Pvaadin.productionMode and test that CTRL+C kills the app
    • Test both Vaadin UI by opening http://localhost:8080 in your browser, and also REST via curl http://localhost:8080/rest
  5. Unzip testapp/build/distributions/testapp-*.zip, then run it and test that both CTRL+C and Enter correctly shuts down the app.

Releasing

To release the library to Maven Central:

  1. Run system tests: cd test && ./system.rb
  2. Edit build.gradle.kts and remove -SNAPSHOT in the version= stanza, e.g. "1.2.13"
  3. Edit README.md: bump the version in the Gradle and Maven install snippets under "Using In Your Apps" to match the release
  4. Run ./gradlew clean build publish closeAndReleaseStagingRepositories
  5. (Optional) watch Maven Central Publishing Deployments as the deployment is published.
  6. Commit with the commit message of simply being the version being released, e.g. "1.2.13"
  7. git tag the commit with the same tag name as the commit message above, e.g. 1.2.13
  8. git push, git push --tags
  9. Add the -SNAPSHOT back to the version= while increasing the version to something which will be released in the future, e.g. 1.2.14-SNAPSHOT, then commit with the commit message "1.2.14-SNAPSHOT" and push.