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

[2.x] examples removal #8676

Merged
merged 2 commits into from
Apr 24, 2024
Merged

Conversation

senivam
Copy link
Member

@senivam senivam commented Apr 18, 2024

Description

(the description is ported with modifications from the 3.x examples removal) PR)

Example removal. Helidon 2 examples now live in the helidon-examples repository

This PR:

  1. Deletes examples from Helidon 2
  2. Updates the examples top-level README to direct users to helidon-examples
  3. Updates the examples profile to include a module called helidon-examples (instead of examples)
  4. Adds a build-examples script that clones the helidon-examples repository into the helidon-examples directory (if it doesn't already exist) and builds the examples.
  5. Adds helidon-examples to .gitignore

The last three items establish a pattern that can be used by developers to more easily work on changes to examples and core helidon concurrently.

Developing Examples

To make it a bit easier working in two different repositories (helidon and helidon-examples) you can use this workflow:

  1. Checkout your 2.x branch and build it
  2. Run etc/scripts/build-examples.sh. This will clone the examples repository's dev-2.x branch into helidon-examples and build it
  3. In your IDE under Maven configuration select the examples profile.

If you need to coordinate a (possibly breaking) change in the main helidon repo and in helidon-examples

  1. Create your branch in both local repositories
  2. Create pull requests against both repositories.
  3. The PR against helidon might fail the examples validation. But it will not block the PR.
  4. The PR against helidon-examples might fail validation. If so it will block the PR.
  5. Merge the PR against helidon
  6. Re-trigger validation on the helidon-examples PR which should now pass. Then merge.

Signed-off-by: Maxim Nesen <[email protected]>
@senivam senivam added examples 2.x Issues for 2.x version branch labels Apr 18, 2024
@senivam senivam self-assigned this Apr 18, 2024
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Apr 18, 2024
@senivam senivam marked this pull request as ready for review April 18, 2024 19:54
@barchetta barchetta merged commit 8be9b66 into helidon-io:helidon-2.x Apr 24, 2024
12 checks passed
@senivam senivam deleted the 2.x-example-removal branch April 24, 2024 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Issues for 2.x version branch examples OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants