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

3.x example removal #8437

Merged
merged 9 commits into from
Feb 29, 2024
Merged

Conversation

barchetta
Copy link
Member

@barchetta barchetta commented Feb 28, 2024

Description

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

This PR:

  1. Deletes examples from Helidon 3
  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 establishes a pattern that can be used by developers to more easily work on changes to examples and core helidon concurrently.

Documentation

Any documentation that references examples will need to have those links updated.

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 3.x branch and build it
  2. Run etc/scripts/build-examples.sh. This will clone the examples repository's dev-3.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.

@barchetta barchetta self-assigned this Feb 28, 2024
@oracle-contributor-agreement oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Feb 28, 2024
@barchetta barchetta marked this pull request as ready for review February 28, 2024 23:19
@barchetta barchetta merged commit 4a017fb into helidon-io:helidon-3.x Feb 29, 2024
12 checks passed
@senivam senivam mentioned this pull request Apr 18, 2024
This was referenced Jul 24, 2024
@barchetta barchetta deleted the 3.x-example-removal branch October 4, 2024 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OCA Verified All contributors have signed the Oracle Contributor Agreement.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants