Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update CONTRIBUTING.md with shortcut command for assembling only the tar distribution #35276

Merged
merged 4 commits into from
Nov 7, 2018
Merged

Docs: Update CONTRIBUTING.md with shortcut command for assembling only the tar distribution #35276

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a1c5325
Docs: Update CONTRIBUTING.md with shortcut command for assembling onl…
cjcenizal Nov 5, 2018
8344828
Introduce tar build command first.
cjcenizal Nov 6, 2018
5a516a1
Add note about --parallel flag.
cjcenizal Nov 6, 2018
b24b980
Merge mention of --parallel flag into other commands.
cjcenizal Nov 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,26 @@ the settings window and/or restart IntelliJ to see your changes take effect.

### Creating A Distribution

To create a distribution from the source, simply run:
Run all build commands from within the root directory:

```sh
cd elasticsearch/
./gradlew assemble
```

To build a tar distribution, run this command:

```sh
./gradlew -p distribution/archives/tar assemble --parallel
```

You will find the distribution under:
`./distribution/archives/tar/build/distributions/`

To create all build artifacts (e.g., plugins and Javadocs) as well as
distributions in all formats, run this command:

```sh
./gradlew assemble --parallel
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we can leave this paragraph out and put the --parallel on the two build commands (tar assemble and full assemble).

Copy link
Contributor Author

@cjcenizal cjcenizal Nov 6, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is --parallel needed/useful when building just the tar?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does make the build process faster, since pieces of compilation can occur as the dependencies are ready.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it applies to both.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks!

```

The package distributions (Debian and RPM) can be found under:
Expand All @@ -209,7 +224,6 @@ The package distributions (Debian and RPM) can be found under:
The archive distributions (tar and zip) can be found under:
`./distribution/archives/(tar|zip)/build/distributions/`


### Running The Full Test Suite

Before submitting your changes, run the test suite to make sure that nothing is broken, with:
Expand Down