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/12 22:53:33 UTC
[beam-site] branch mergebot updated (6cfd3ba -> c2e16d4)
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a change to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git.
from 6cfd3ba Prepare repository for deployment.
new e12f932 Update Eclipse documentation for Gradle build.
new 2b44c8c Typo fix
new 07dd232 Remove reference to now-deleted documentation
new c2e16d4 This closes #419
The 4 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
mergebot-role@apache.org.
[beam-site] 02/04: Typo fix
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 2b44c8c104ab7c13bdb6c8e7b04a552dcf2f8d08
Author: Melissa Pashniak <me...@google.com>
AuthorDate: Thu Apr 12 13:59:32 2018 -0700
Typo fix
---
src/contribute/eclipse.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/contribute/eclipse.md b/src/contribute/eclipse.md
index 592851e..2cf0484 100644
--- a/src/contribute/eclipse.md
+++ b/src/contribute/eclipse.md
@@ -48,11 +48,11 @@ 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 now errors.
+succeed with no errors.
## Building
-Once your Eclipse workspace is properly setup, you will have a "Gradle
+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".
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.
[beam-site] 01/04: Update Eclipse documentation for Gradle build.
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit e12f93209d6055f6a63d3675217a8c8db1d59712
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 | 57 ++++++++++++++++++++++++++---------------------
1 file changed, 31 insertions(+), 26 deletions(-)
diff --git a/src/contribute/eclipse.md b/src/contribute/eclipse.md
index e0cf477..592851e 100644
--- a/src/contribute/eclipse.md
+++ b/src/contribute/eclipse.md
@@ -17,42 +17,47 @@ 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
+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.
+1. Before setting up Eclipse integration, verify that you can successfully build
+ from the commandline using instructions from the [Contribution guide]({{ site.baseurl }}/contribute/contribution-guide#building).
- Help
- -> Eclipse Marketplace
- -> Search for "m2 apt"
- -> Install m2e-apt 1.2 or higher
+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.
-2. Activate the apt processing
+1. Install [Buildship Gradle
+ Integration](https://marketplace.eclipse.org/content/buildship-gradle-integration).
+ This will allow importing and interacting with the Gradle build.
- Window
- -> Preferences
- -> Maven
- -> Annotation processing
- -> Switch to Experimental: Delegate annotation processing ...
- -> Ok
+1. Open the project import wizard in Eclipse via "File" > "Import".
-3. Import the beam projects
+1. From the "Import" screen, select "Gradle" > "Existing Gradle Project", and click
+ Next.
- File
- -> Import...
- -> Existing Maven Projects
- -> Browse to the directory you cloned into and select "beam"
- -> make sure all beam projects are selected
- -> Finalize
+1. From the "Import Gradle Project" screen, fill in the Project root directory
+ with your local git path, and click Finish.
-You now should have all the beam projects imported into Eclipse and should see
-no compile errors.
+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 now errors.
+
+## Building
+
+Once 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
mergebot-role@apache.org.
[beam-site] 04/04: This closes #419
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit c2e16d4b2996450173f31f8c8fd678a001a1ddca
Merge: 6cfd3ba 07dd232
Author: Mergebot <me...@apache.org>
AuthorDate: Thu Apr 12 15:53:03 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
mergebot-role@apache.org.
[beam-site] 03/04: Remove reference to now-deleted documentation
Posted by me...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
mergebot-role pushed a commit to branch mergebot
in repository https://gitbox.apache.org/repos/asf/beam-site.git
commit 07dd232fa9a1ecedcff32448fd90aed215fdb40f
Author: Scott Wegner <sw...@google.com>
AuthorDate: Thu Apr 12 14:24:27 2018 -0700
Remove reference to now-deleted documentation
---
content/contribute/eclipse/index.html | 75 +++++++++++++++++++++--------------
src/contribute/eclipse.md | 17 +++++---
2 files changed, 57 insertions(+), 35 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>
diff --git a/src/contribute/eclipse.md b/src/contribute/eclipse.md
index 2cf0484..346fbaa 100644
--- a/src/contribute/eclipse.md
+++ b/src/contribute/eclipse.md
@@ -18,14 +18,21 @@ section_menu: section-menu/contribute.html
## Eclipse version
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.
+[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. Before setting up Eclipse integration, verify that you can successfully build
- from the commandline using instructions from the [Contribution guide]({{ site.baseurl }}/contribute/contribution-guide#building).
+Before setting up Eclipse integration, verify that you can successfully build
+from the commandline by building a sample package:
+
+```
+./gradlew :beam-examples-java:build
+```
+
+If you receive any errors, first verify your environment setup based on the
+[Contribution guide]({{ site.baseurl }}/contribute/contribution-guide#one-time-setup).
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
--
To stop receiving notification emails like this one, please contact
mergebot-role@apache.org.