You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by me...@apache.org on 2018/04/18 16:41:04 UTC
[beam-site] branch asf-site updated (8c4f2a9 -> c649ee5)
This is an automated email from the ASF dual-hosted git repository.
melap pushed a change to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git.
from 8c4f2a9 Prepare repository for deployment.
new efbe42e Update Eclipse documentation for Gradle build.
new d5bfe58 Regenerate website
new c649ee5 This closes #419
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
content/contribute/eclipse/index.html | 75 +++++++++++++++++++++--------------
src/contribute/eclipse.md | 66 +++++++++++++++++-------------
2 files changed, 84 insertions(+), 57 deletions(-)
--
To stop receiving notification emails like this one, please contact
melap@apache.org.
[beam-site] 01/03: Update Eclipse documentation for Gradle build.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
melap pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit efbe42e832d667430139a41e71c75bc7a5bb2420
Author: Scott Wegner <sw...@google.com>
AuthorDate: Wed Apr 11 16:23:36 2018 -0700
Update Eclipse documentation for Gradle build.
---
src/contribute/eclipse.md | 66 ++++++++++++++++++++++++++++-------------------
1 file changed, 39 insertions(+), 27 deletions(-)
diff --git a/src/contribute/eclipse.md b/src/contribute/eclipse.md
index e0cf477..346fbaa 100644
--- a/src/contribute/eclipse.md
+++ b/src/contribute/eclipse.md
@@ -17,42 +17,54 @@ section_menu: section-menu/contribute.html
## Eclipse version
-Use a recent Eclipse version that includes m2e. Currently we recommend Eclipse
-Neon. Start Eclipse with a fresh workspace in a separate directory from your
-checkout.
+Use a recent Eclipse version that includes
+[Buildship](https://projects.eclipse.org/projects/tools.buildship) for Gradle
+integration. Currently we recommend Eclipse Oxygen. Start Eclipse with a fresh
+workspace in a separate directory from your checkout.
## Initial setup
-1. Install m2e-apt: Beam uses apt annotation processing to provide auto
- generated code. One example is the usage of [Google
- AutoValue](https://github.com/google/auto/tree/master/value). By default m2e
- does not support this and you will see compile errors.
+Before setting up Eclipse integration, verify that you can successfully build
+from the commandline by building a sample package:
- Help
- -> Eclipse Marketplace
- -> Search for "m2 apt"
- -> Install m2e-apt 1.2 or higher
+```
+./gradlew :beam-examples-java:build
+```
-2. Activate the apt processing
+If you receive any errors, first verify your environment setup based on the
+[Contribution guide]({{ site.baseurl }}/contribute/contribution-guide#one-time-setup).
- Window
- -> Preferences
- -> Maven
- -> Annotation processing
- -> Switch to Experimental: Delegate annotation processing ...
- -> Ok
+1. If running on Mac or Linux, launch Eclipse from a terminal. This is necessary
+ to ensure that Eclipse has proper environment setup from user profile
+ scripts, i.e. .bashrc.
-3. Import the beam projects
+1. Install [Buildship Gradle
+ Integration](https://marketplace.eclipse.org/content/buildship-gradle-integration).
+ This will allow importing and interacting with the Gradle build.
- File
- -> Import...
- -> Existing Maven Projects
- -> Browse to the directory you cloned into and select "beam"
- -> make sure all beam projects are selected
- -> Finalize
+1. Open the project import wizard in Eclipse via "File" > "Import".
-You now should have all the beam projects imported into Eclipse and should see
-no compile errors.
+1. From the "Import" screen, select "Gradle" > "Existing Gradle Project", and click
+ Next.
+
+1. From the "Import Gradle Project" screen, fill in the Project root directory
+ with your local git path, and click Finish.
+
+Eclipse will scan the project tree and import each as a separate
+Package.
+
+Verify that your workspace is correctly configured by invoking
+'beam-runners-direct-java:build' from the "Gradle Tasks" pane. The build should
+succeed with no errors.
+
+## Building
+
+After your Eclipse workspace is properly setup, you will have a "Gradle
+Tasks" window with a set of operations. If you don't see the pane, open it
+from "Window" > "Show View" > Other.. > "Gradle" > "Gradle Tasks".
+
+From the "Gradle Tasks" window, you can build any task registered with Gradle.
+For example, if you are working on Kinesis IO, select 'beam-sdks-java-io-kinesis:build'.
## Checkstyle
--
To stop receiving notification emails like this one, please contact
melap@apache.org.
[beam-site] 02/03: Regenerate website
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
melap pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit d5bfe584d4c0033d36056ae2c3279cdf1761065e
Author: melissa <me...@google.com>
AuthorDate: Wed Apr 18 09:27:38 2018 -0700
Regenerate website
---
content/contribute/eclipse/index.html | 75 +++++++++++++++++++++--------------
1 file changed, 45 insertions(+), 30 deletions(-)
diff --git a/content/contribute/eclipse/index.html b/content/contribute/eclipse/index.html
index 089d5b7..b75aaa9 100644
--- a/content/contribute/eclipse/index.html
+++ b/content/contribute/eclipse/index.html
@@ -147,6 +147,7 @@
<ul class="nav">
<li><a href="#eclipse-version">Eclipse version</a></li>
<li><a href="#initial-setup">Initial setup</a></li>
+ <li><a href="#building">Building</a></li>
<li><a href="#checkstyle">Checkstyle</a></li>
<li><a href="#code-style">Code Style</a></li>
</ul>
@@ -171,48 +172,62 @@
<h2 id="eclipse-version">Eclipse version</h2>
-<p>Use a recent Eclipse version that includes m2e. Currently we recommend Eclipse
-Neon. Start Eclipse with a fresh workspace in a separate directory from your
-checkout.</p>
+<p>Use a recent Eclipse version that includes
+<a href="https://projects.eclipse.org/projects/tools.buildship">Buildship</a> for Gradle
+integration. Currently we recommend Eclipse Oxygen. Start Eclipse with a fresh
+workspace in a separate directory from your checkout.</p>
<h2 id="initial-setup">Initial setup</h2>
+<p>Before setting up Eclipse integration, verify that you can successfully build
+from the commandline by building a sample package:</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>./gradlew :beam-examples-java:build
+</code></pre>
+</div>
+
+<p>If you receive any errors, first verify your environment setup based on the
+<a href="/contribute/contribution-guide#one-time-setup">Contribution guide</a>.</p>
+
<ol>
<li>
- <p>Install m2e-apt: Beam uses apt annotation processing to provide auto
-generated code. One example is the usage of <a href="https://github.com/google/auto/tree/master/value">Google
-AutoValue</a>. By default m2e
-does not support this and you will see compile errors.</p>
-
- <p>Help
- -> Eclipse Marketplace
- -> Search for “m2 apt”
- -> Install m2e-apt 1.2 or higher</p>
+ <p>If running on Mac or Linux, launch Eclipse from a terminal. This is necessary
+to ensure that Eclipse has proper environment setup from user profile
+scripts, i.e. .bashrc.</p>
</li>
<li>
- <p>Activate the apt processing</p>
-
- <p>Window
- -> Preferences
- -> Maven
- -> Annotation processing
- -> Switch to Experimental: Delegate annotation processing …
- -> Ok</p>
+ <p>Install <a href="https://marketplace.eclipse.org/content/buildship-gradle-integration">Buildship Gradle
+Integration</a>.
+This will allow importing and interacting with the Gradle build.</p>
</li>
<li>
- <p>Import the beam projects</p>
-
- <p>File
- -> Import…
- -> Existing Maven Projects
- -> Browse to the directory you cloned into and select “beam”
- -> make sure all beam projects are selected
- -> Finalize</p>
+ <p>Open the project import wizard in Eclipse via “File” > “Import”.</p>
+ </li>
+ <li>
+ <p>From the “Import” screen, select “Gradle” > “Existing Gradle Project”, and click
+Next.</p>
+ </li>
+ <li>
+ <p>From the “Import Gradle Project” screen, fill in the Project root directory
+with your local git path, and click Finish.</p>
</li>
</ol>
-<p>You now should have all the beam projects imported into Eclipse and should see
-no compile errors.</p>
+<p>Eclipse will scan the project tree and import each as a separate
+Package.</p>
+
+<p>Verify that your workspace is correctly configured by invoking
+‘beam-runners-direct-java:build’ from the “Gradle Tasks” pane. The build should
+succeed with no errors.</p>
+
+<h2 id="building">Building</h2>
+
+<p>After your Eclipse workspace is properly setup, you will have a “Gradle
+Tasks” window with a set of operations. If you don’t see the pane, open it
+from “Window” > “Show View” > Other.. > “Gradle” > “Gradle Tasks”.</p>
+
+<p>From the “Gradle Tasks” window, you can build any task registered with Gradle.
+For example, if you are working on Kinesis IO, select ‘beam-sdks-java-io-kinesis:build’.</p>
<h2 id="checkstyle">Checkstyle</h2>
--
To stop receiving notification emails like this one, please contact
melap@apache.org.
[beam-site] 03/03: This closes #419
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
melap pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit c649ee5cadc865d47e9f4d8d8f37bdb857f01774
Merge: 8c4f2a9 d5bfe58
Author: melissa <me...@google.com>
AuthorDate: Wed Apr 18 09:27:38 2018 -0700
This closes #419
content/contribute/eclipse/index.html | 75 +++++++++++++++++++++--------------
src/contribute/eclipse.md | 66 +++++++++++++++++-------------
2 files changed, 84 insertions(+), 57 deletions(-)
--
To stop receiving notification emails like this one, please contact
melap@apache.org.