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

Quickstart guide should not require building the library #342

Open
nwbirnie opened this issue Sep 22, 2020 · 2 comments
Open

Quickstart guide should not require building the library #342

nwbirnie opened this issue Sep 22, 2020 · 2 comments
Assignees
Labels
enhancement New feature or request P3 Prospects for future development or feature requests that would be nice to have. Typos or minor bugs

Comments

@nwbirnie
Copy link
Contributor

Build times are O(20 minutes) which is a bad experience for folks onboarding to the library. Provide a quickstart guide which doesn't require mvn clean install on the project.

@nwbirnie nwbirnie added the enhancement New feature or request label Sep 22, 2020
@nwbirnie
Copy link
Contributor Author

We could release the examples project and use the maven artifacts directly on the command line.

@jradcliff
Copy link
Member

Another option is to modify the instructions for running examples to:

  1. Clone then check out the latest release tag.
  2. Modify the command line to run an example to use a maven profile where the examples project is not in the parent pom. This should make the example go to the maven repo to pick up the library dependency.

Alternative to step 2 above

As part of the release:

  • Set enabledByDefault to true in the sonatype profile
  • Set enabledByDefault to false in the examples-project profile
  • This should be the state when the release tag is set.
  • In the next phase of the release, when setting up SNAPSHOT versions, undo the profile changes above.

@nwbirnie nwbirnie added the P3 Prospects for future development or feature requests that would be nice to have. Typos or minor bugs label Mar 24, 2021
@jradcliff jradcliff self-assigned this Apr 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P3 Prospects for future development or feature requests that would be nice to have. Typos or minor bugs
Projects
None yet
Development

No branches or pull requests

2 participants