solr icon indicating copy to clipboard operation
solr copied to clipboard

SOLR-15685: Add Devcontainer to make building easier

Open TheSench opened this issue 4 years ago • 2 comments

https://issues.apache.org/jira/browse/SOLR-15685

Description

This PR adds a .devcontainer, which provides a Docker Perl/JDK11 build environment. This can be used for new/infrequent contributors to quickly get up and running without needing to install any build tools.

Solution

Using VSCode's Remote Development extension to add the Perl .devcontainer (includes Perl 5). I then updated the auto-generated Dockerfile to include the Java 11 JDK. With these changes, I am able to assemble Solr inside a Docker container without needing to install any other build tools on my machine.

Tests

I started up the container and ran gradlew assemble inside of it. Once the build finished, I ran the generated bin/solr to verify that Solr was able to start.

Checklist

Please review the following and check all that apply:

  • [x] I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • [x] I have created a Jira issue and added the issue ID to my pull request title.
  • [x] I have given Solr maintainers access to contribute to my PR branch. (optional but recommended)
  • [x] I have developed this patch against the main branch.
  • [x] I have run ./gradlew check.

N/A I have added tests for my changes.

TheSench avatar Oct 10 '21 11:10 TheSench

Not sure what the proper way to proceed is regarding the license in the common-debian.sh script that gets autogenerated. It is licensed under the MIT license. If this change is not something we want to add, I think the proper alternative would be to add .devcontainer/ to the .gitignore so that individual developers can choose to use one without accidentally committing it.

TheSench avatar Oct 10 '21 19:10 TheSench

This PR had no visible activity in the past 60 days, labeling it as stale. Any new activity will remove the stale label. To attract more reviewers, please tag someone or notify the [email protected] mailing list. Thank you for your contribution!

github-actions[bot] avatar Feb 24 '24 00:02 github-actions[bot]