Skip to content

Commit

Permalink
GEODE-6513: Revised README and BUILDING
Browse files Browse the repository at this point in the history
* Better IntelliJ integration via 'Before Executing' triggers with
Gradle.
* Added screenshot of IntelliJ configuration.
* Replaced old Travis badge with Concourse
* Remove stale reference to Travis in PR template, replace with
concourse
* Grammar fixes in README

Authored-by: Robert Houghton <rhoughton@pivotal.io>
  • Loading branch information
robbadler committed Mar 21, 2019
1 parent 28d65eb commit 301700d
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -17,6 +17,6 @@ to ensure the following steps have been taken:
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?

### Note:
Please ensure that once the PR is submitted, you check travis-ci for build issues and
Please ensure that once the PR is submitted, check Concourse for build issues and
submit an update to your PR as soon as possible. If you need help, please send an
email to dev@geode.apache.org.
21 changes: 14 additions & 7 deletions BUILDING.md
Expand Up @@ -35,26 +35,33 @@ Note: on Windows invoke the `gfsh.bat` script to print the version string.

The following steps have been tested with:

* **IntelliJ IDEA 2018.2.2**
* **IntelliJ IDEA 2018.3.5**

1. Run `./gradlew --parallel devBuild` from Geode repository root to create compiler generated source
1. Run `./gradlew --parallel generate` from Geode repository root to create compiler generated source.
1. Alternatively (and to ensure these sources stay up-to-date):
- Perform step 2
- In the **Gradle** dockable, expand the **geode** (the root project) -> **Tasks** -> **build**
- Right-click **generate** task, select **Execute Before Sync** and **Execute Before Build**
- Click **Refresh All Gradle Projects** at the top of the Gradle dockable

2. Import project into IntelliJ IDEA
![After](https://cwiki.apache.org/confluence/download/attachments/103096184/geode-generate-before-sync.png?api=v2)

2. Import project into IntelliJ IDEA.

From the **Welcome to IntelliJ IDEA** window:

1. **Import Project ->** select *build.gradle* file from Geode repository root and press **Open**.
2. Enable **Use auto-import**
2. Optionally, enable **Use auto-import**
3. Enable **Create separate module per source set**
4. Select **Use Project JDK 1.8.0_*nnn*** where *nnn* is latest build required for Geode

3. Change Code Style Scheme to GeodeStyle
3. Change Code Style Scheme to GeodeStyle.

Navigate to **IntelliJ IDEA -> Preferences... -> Editor -> Code Style**. Select *GeodeStyle* in Scheme drop-down box if it already exists.

To define the *GeodeStyle* in **Scheme**, select the gear icon next to the drop-down box, click **Import Scheme ->** and select **IntelliJ IDEA code style XML**. Select *etc/intellij-java-modified-google-style.xml* from Geode repository root, enter **To:** *GeodeStyle*, check **Current scheme** and press **OK**.

4. Make Apache the default Copyright
4. Make Apache the default Copyright.

Navigate to **IntelliJ IDEA -> Preferences... -> Editor -> Copyright**. Select *Apache* in drop-down box **Default project copyright**.

Expand All @@ -79,7 +86,7 @@ The following steps have been tested with:

Navigate to **IntelliJ IDEA -> Preferences... -> Editor -> Copyright -> Formatting**. Uncheck **Add blank line after** and press **OK**.

5. Rebuild Project
5. Rebuild the Project.

Navigate to **Build -> Rebuild Project** and the full project should compile without errors.

Expand Down
7 changes: 3 additions & 4 deletions README.md
@@ -1,7 +1,6 @@
[<img src="https://geode.apache.org/img/apache_geode_logo.png" align="center"/>](http://geode.apache.org)

[![Build Status](https://travis-ci.org/apache/geode.svg?branch=develop)](https://travis-ci.org/apache/geode) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.geode/geode-core/badge.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.geode%22) [![homebrew](https://img.shields.io/homebrew/v/apache-geode.svg)](http://brewformulas.org/ApacheGeode) [![Docker Pulls](https://img.shields.io/docker/pulls/apachegeode/geode.svg)](https://hub.docker.com/r/apachegeode/geode/)

[![Build Status](https://concourse.apachegeode-ci.info/api/v1/teams/main/pipelines/apache-develop-main/jobs/Build/badge)](https://concourse.apachegeode-ci.info/teams/main/pipelines/apache-develop-main) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.geode/geode-core/badge.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.geode%22) [![homebrew](https://img.shields.io/homebrew/v/apache-geode.svg)](http://brewformulas.org/ApacheGeode) [![Docker Pulls](https://img.shields.io/docker/pulls/apachegeode/geode.svg)](https://hub.docker.com/r/apachegeode/geode/)

## Contents
1. [Overview](#overview)
Expand Down Expand Up @@ -110,11 +109,11 @@ Apache Geode includes the following features:

## <a name="building"></a>Building this Release from Source

See [BUILDING.md](https://github.com/apache/geode/blob/develop/BUILDING.md) for
See [BUILDING.md](./BUILDING.md) for
instructions on how to build the project.

## <a name="testing"></a>Running Tests
See [TESTING.md](https://github.com/apache/geode/blob/develop/TESTING.md) for
See [TESTING.md](./TESTING.md) for
instructions on how to run tests.

## <a name="started"></a>Geode in 5 minutes
Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Expand Up @@ -137,7 +137,7 @@ task writeBuildInfo {
}
}

task generate() {
tasks.register('generate') {
group = 'Build'
description = "Top-level target for all source generation. Helps IDE integration"
// This task is a no-op, with other tasks (such as geode-protobuf-messages:generateProto)
Expand Down

0 comments on commit 301700d

Please sign in to comment.