Setup Tips for Prerequisites

The following steps can help to set up the environment listed in the Contribution guide

For MacOS

1. Install Java 8, Go 1.12, pyenv and Docker using homebrew.
   1. Check the following tutorial How to install Java 8 on Mac.

2. Use pyenv to install the python versions, 3.7, 3.8.
   
   

   So far, 3.6 is throwing errors.

3. Use pip (installed when installing pyenv) to install setuptools, virtualenv, and tox.
4. Clone the apache beam project from https://github.com/apache/beam 

   using main branch. 

   1. cd into the /beam root project

5. Execute the following commands:
   
   

   ./gradlew projects
   

   ./gradlew tasks
   

6. To make sure Java environment is correctly installed, execute:

   ./gradlew -p sdks/java/io/cassandra check
   

   ./gradlew -p runners/flink check
   

For Windows

(in construction) 

1. https://github.com/pyenv-win/pyenv-win

Beam Jira Beginner's Guide

Beam Testing Tools FAQ

Commiters FAQ

Contribution Testing Guide

Eclipse Tips

Git Tips

• Spotless pre-commit

Go Tips

• Supporting Streaming in the Go SDK

Gradle Tips

Java Tips

• Dataflow Worker overview graphs
• Dependency Upgrades

Jenkins Tips

Jira Dashboards

Jira Tips

Multi-language Pipelines Tips

Python Tips

• Add/Remove Python version in Apache Beam

Release

Setup Tips

Using IntelliJ IDE

• (FAQ) Recovering from common IDE errors
• Additional Plugin Integrations
• Build and test a single module
• Finding Help with IntelliJ
• Perform a full build
• Recover from IntelliJ project corruption
• Run a single IT for a particular runner
• Run a single unit test
• Running a single validates runner test
• Set up IntelliJ from scratch
  • Set up IntelliJ for Python development

Website Tips