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.

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

Updating contributing.md #244

Closed
wants to merge 104 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
104 commits
Select commit Hold shift + click to select a range
1f40732
[PURIFY] Remove x-pack directory
nknize Jan 26, 2021
35ecb4e
[PURIFY] Remove docs directory (#3)
nknize Jan 30, 2021
65cd98f
Cleanup build-scan, remove publish scan to elastic server (#1) (#4)
nknize Jan 30, 2021
0b8ed9f
[PURIFY] remove all trace of x-pack eql (#5)
nknize Jan 30, 2021
33c8ac7
[PURIFY] remove issue, pr tempalte to avoid confusion, we could add o…
nknize Jan 30, 2021
4bdad9f
[PURIFY] update build.gradle files to ensure build completes; gradle …
nknize Jan 30, 2021
6744e35
Cleanup build script to exclude security-authorization-engine (#8) (#8)
nknize Jan 30, 2021
16ae5f1
[PURIFY] remove all trace of x-pack enrichment processor (#9)
nknize Jan 30, 2021
712a80e
[PURIFY] remove all trace of x-pack async-search (#10)
nknize Jan 30, 2021
b3f56c6
[PURIFY] remove all trace of x-pack ccr (#11)
nknize Jan 30, 2021
809e5aa
Remove the Elastic license file, all checks for this license and the …
nknize Jan 30, 2021
399219b
[PURIFY] remove all trace of x-pack graph (#13)
nknize Jan 30, 2021
7505372
[PURIFY] remove all trace of x-pack ml (#14)
nknize Jan 30, 2021
70c38d4
[PURIFY] Add InferenceConfig to org.elasticsearch.client.analytics (#15)
nknize Jan 30, 2021
4d4f198
[PURIFY] remove all trace of x-pack security (#16)
nknize Jan 30, 2021
a352543
[PURIFY] remove all trace of x-pack rollups (#17)
nknize Jan 30, 2021
e139bda
[PURIFY] remove all trace of x-pack sql (#18)
nknize Jan 30, 2021
e1d4d79
[PURIFY] remove all trace of x-pack migration (#19)
nknize Jan 30, 2021
055d5ca
[PURIFY] remove all trace of x-pack index lifecycle management (#20)
nknize Jan 30, 2021
1827eff
[PURIFY] remove all trace of x-pack watcher (#21)
nknize Jan 30, 2021
dbcf046
[PURIFY] remove all trace of x-pack monitoring (#22)
nknize Jan 30, 2021
73a7bab
[PURIFY] Remove remaining x-pack license. (#25)
adnapibar Feb 2, 2021
4190b40
[PURIFY] Revert "Move data stream transport and rest action to xpack …
nknize Feb 2, 2021
fb9fe9f
[PURIFY] remove all trace of x-pack transforms (#31)
nknize Feb 2, 2021
b55d8f4
[PURIFY] fix GetDataStreamsRequestTests build failure
nknize Feb 2, 2021
f8144e1
[PURIFY] Remove the AuthorizationEnginePlugin from examples. (#26)
adnapibar Feb 2, 2021
d496925
Fix compilation issues for tests. (#29)
adnapibar Feb 2, 2021
5dd4a82
[PURIFY] Cleanup build and unblock HLRC integration tests (#33)
nknize Feb 3, 2021
d9ae459
Adding initial CI workflow for search (#35)
saratvemulapalli Feb 3, 2021
2be74b1
[TEST] Fix unit test failure in RestHighLevelClientTests (#36)
Feb 4, 2021
f49fb70
[TEST] fix DeleteDataStreamRequestTests failure (#37)
nknize Feb 4, 2021
7aa4833
Remove license option in gradlew command (#41)
harold-wang Feb 4, 2021
fa86308
Remove x-pack from build, distribution and packaging. (#43)
adnapibar Feb 4, 2021
7e42224
Removing _reload_search_analyzers related changes since the related x…
setiah Feb 5, 2021
914d30e
Fixing Rest Converters Tests after x-pack removal (#54)
saratvemulapalli Feb 6, 2021
23d2e50
Remove license statement from CONTRIBUTING.md (#58)
harold-wang Feb 8, 2021
f2f1bfa
Revert back refresh policy in RequestConverters. (#55)
adnapibar Feb 8, 2021
6f90868
Remove unused imports in RemoteClustersIT and InternalTestCluster
nknize Feb 8, 2021
9bed5c2
[DOCS] temporarily comment verifyDocsLuceneVersion in qa:verify-versi…
nknize Feb 8, 2021
ac45e3f
Mute AnalyticsAggsIT test failure
nknize Feb 8, 2021
94301ea
[MUTE] AwaitsFix failing tests
nknize Feb 9, 2021
2a901cc
Remove packaging tests for the x-pack command line tools. (#56)
adnapibar Feb 9, 2021
ae1727d
Remove x-pack aggregations. (#59)
adnapibar Feb 9, 2021
1bbc9b4
Remove x-pack data-frame analytics hlrc. (#62)
adnapibar Feb 9, 2021
6712670
Remove ILM policy from GetDataStreamAction Response. (#63)
adnapibar Feb 9, 2021
be00040
Ensure ReplicationOperation notify listener once (#68256)
dnhatn Jan 31, 2021
95e87ae
Fix search template request (#43509)
jdconrad Jun 25, 2019
bcb5c7f
Lower skip version for token_cound yaml test (#68583)
Feb 8, 2021
55b539e
Revert previous change to fix import issue.
adnapibar Feb 9, 2021
dac6af6
Remove unused imports in ArchiveTests
nknize Feb 9, 2021
7da7e34
Fix unit test for removal of x-pack aggregations. (#65)
adnapibar Feb 9, 2021
aab68fa
[PURIFY] Remove ProtocolUtils, TimeUtils, and XContentSource from HLR…
nknize Feb 9, 2021
a40924f
[PURIFY] Remove x-pack feature flag from yaml test (#68)
nknize Feb 9, 2021
5172928
Remove testcase testSearchWithBasicLicensedQuery since basic license …
harold-wang Feb 9, 2021
8654d6e
Remove UnusedImports (#76)
harold-wang Feb 10, 2021
52a3f37
Bring back the REST specs for data streams. (#78)
adnapibar Feb 10, 2021
75162da
Remove unused imports after x-pack feature flag removed from yaml tes…
Feb 10, 2021
6ba8876
[TEST] Fix Feature Flags in Test Framework and SortTemplates yaml fai…
nknize Feb 10, 2021
88542a7
Run precommit and unit tests as part of github actions. (#84)
adnapibar Feb 11, 2021
8f069ed
Removing FreezeIndex related code since its x-pack counterpart is rem…
abbashus Feb 11, 2021
93f3dd5
Only run pre-commit checks in GitHub actions. (#94)
adnapibar Feb 12, 2021
b29f47b
Fixing Bwc checks for 7.10.3 (#93)
saratvemulapalli Feb 12, 2021
482b187
Temporary fix for license check path for debian packaging. (#97)
adnapibar Feb 15, 2021
7114dd3
Disable plugincli feature (#101)
adnapibar Feb 15, 2021
baf563f
Update CONTRIBUTING.md
CEHENKLE Feb 18, 2021
7710ba2
Update CONTRIBUTING.md
CEHENKLE Feb 18, 2021
d135245
Support for continious integration with Jenkins (#96)
Feb 18, 2021
3b27a82
Create DEVELOPER_GUIDE.md
CEHENKLE Feb 19, 2021
460b564
Update CONTRIBUTING.md
CEHENKLE Feb 19, 2021
f22769e
Update CONTRIBUTING.md
CEHENKLE Feb 19, 2021
e1538b7
Update CONTRIBUTING.md
CEHENKLE Feb 19, 2021
601c734
Update CONTRIBUTING.md
CEHENKLE Feb 19, 2021
098fa0c
Update CONTRIBUTING.md
CEHENKLE Feb 19, 2021
fd36020
Remove any non oss from build, package, and distribution (#102)
nknize Feb 22, 2021
e607275
Style, accessibility, typo fixes (#109)
stockholmux Feb 23, 2021
4960dc9
Add version number to fork sentence
jcgraybill Feb 23, 2021
d4b12e7
"licensed" -> "released"
jcgraybill Feb 23, 2021
ca549b2
Remove x-pact from RESI API username and password (#117)
harold-wang Feb 23, 2021
d7e6aa0
Update signoff message (#121)
harold-wang Feb 24, 2021
5515b07
Update CI workflow to work on new infra (#123)
peternied Feb 24, 2021
462a0f1
Update .gitignore
peterzhuamazon Feb 24, 2021
e66c684
Update .gitignore
peterzhuamazon Feb 24, 2021
fba2d4c
Disable BWC checks. (#130)
Feb 24, 2021
ead8891
Create CODE_OF_CONDUCT.md (#124)
CEHENKLE Feb 25, 2021
547fdcb
Update developer guide (#136)
harold-wang Mar 1, 2021
29d5b00
Add script to perform signoff check between commits (#152)
peternied Mar 1, 2021
c50e8c8
[Rename] server/src/main/java/org/apache (#162)
nknize Mar 2, 2021
7a10440
Revert "[Rename] server/src/main/java/org/apache (#162)"
nknize Mar 2, 2021
3f2b7e5
Update CONTRIBUTING.md
CEHENKLE Mar 3, 2021
011b577
Update CONTRIBUTING.md
CEHENKLE Mar 3, 2021
dbb6c35
Update CONTRIBUTING.md
CEHENKLE Mar 3, 2021
6341605
Update CONTRIBUTING.md
CEHENKLE Mar 3, 2021
e0be0ea
Update CODE_OF_CONDUCT.md
CEHENKLE Mar 3, 2021
0fd5ef0
Update CONTRIBUTING.md
CEHENKLE Mar 4, 2021
d6855da
Dummy commit to test the CI/CD workflow
bbarani Mar 4, 2021
8efc8e0
Update .gitignore
peterzhuamazon Mar 4, 2021
8ed6084
Fixing transport deserialization with oss distribution (#218)
saratvemulapalli Mar 5, 2021
8f87920
Update LICENSE.txt (#227)
CEHENKLE Mar 6, 2021
ab729f5
Merge branch 'main' into Updating-CONTRIBUTING.md
CEHENKLE Mar 9, 2021
6deeff2
Update DEVELOPER_GUIDE.md
CEHENKLE Mar 10, 2021
dc351cd
Update DEVELOPER_GUIDE.md
CEHENKLE Mar 10, 2021
8661b61
Update DEVELOPER_GUIDE.md
CEHENKLE Mar 11, 2021
0673f50
Update DEVELOPER_GUIDE.md
CEHENKLE Mar 11, 2021
a2119e8
Update DEVELOPER_GUIDE.md
CEHENKLE Mar 15, 2021
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
48 changes: 25 additions & 23 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Developer Guide

So you want to contribute code to RENAMEME? Excellent! We're glad you're here. Here's what you need to do:
So you want to contribute code to OpenSearch? Excellent! We're glad you're here. Here's what you need to do:

## Get project source code

### RENAMEE Repo : https://github.com/opendistro-for-elasticsearch/RENAMEME
### OpenSearch Repo : https://github.com/opensearch-project

###Importing the project into IntelliJ IDEA directly

RENAMEME builds using Java 14. When importing into IntelliJ you will need
OpenSearch builds using Java 14. When importing into IntelliJ you will need
to define an appropriate SDK. The convention is that **this SDK should be named
"14"** so that the project import will detect it automatically. For more details
on defining an SDK in IntelliJ please refer to [their documentation](https://www.jetbrains.com/help/idea/sdk.html#define-sdk).
SDK definitions are global, so you can add the JDK from any project, or after
project import. Importing with a missing JDK will still work, IntelliJ will
simply report a problem and will refuse to build until resolved.

You can import the RENAMAME project into IntelliJ IDEA via:
You can import the OpenSearch project into IntelliJ IDEA via:

- Select **File > Open**
- In the subsequent dialog navigate to the root `build.gradle` file
- In the subsequent dialog select **Open as Project**

###Git clone RENAMAME repo:
git clone https://github.com/opendistro-for-elasticsearch/RENAMEME
###Git clone OpenSearch repo:
git clone https://github.com/opensearch-project
CEHENKLE marked this conversation as resolved.
Show resolved Hide resolved


## Project layout
Expand All @@ -47,26 +47,26 @@ general purpose enough to *belong* in maven central. We're still working out
what to do here.

#### `modules`
Features that are shipped with RENAMEME by default but are not built in to
Features that are shipped with OpenSearch by default but are not built in to
the server. We typically separate features from the server because they require
permissions that we don't believe *all* of RENAMEME should have or because
they depend on libraries that we don't believe *all* of RENAMEME should
permissions that we don't believe *all* of OpenSearch should have or because
they depend on libraries that we don't believe *all* of OpenSearch should
depend on.

For example, reindex requires the `connect` permission so it can perform
reindex-from-remote but we don't believe that the *all* of RENAMEME should
reindex-from-remote but we don't believe that the *all* of OpenSearch should
have the "connect". For another example, Painless is implemented using antlr4
and asm and we don't believe that *all* of RENAMEME should have access to
and asm and we don't believe that *all* of OpenSearch should have access to
them.

#### `plugins`
Officially supported plugins to RENAMEME. We decide that a feature should
Officially supported plugins to OpenSearch. We decide that a feature should
be a plugin rather than shipped as a module because we feel that it is only
important to a subset of users, especially if it requires extra dependencies.

The canonical example of this is the ICU analysis plugin. It is important for
folks who want the fairly language neutral ICU analyzer but the library to
implement the analyzer is 11MB so we don't ship it with RENAMEME by
implement the analyzer is 11MB so we don't ship it with OpenSearch by
default.

Another example is the `discovery-gce` plugin. It is *vital* to folks running
Expand All @@ -75,7 +75,7 @@ dozen extra jars.

## Project Tools

JDK 14 is required to build RENAMEME. You must have a JDK 14 installed
JDK 14 is required to build OpenSearch. You must have a JDK 14 installed
with the environment variable `JAVA_HOME` referencing the path to Java home for
your JDK 14 installation. By default, tests use the same runtime as `JAVA_HOME`.
However, since RENNAMEME supports JDK 8, the build supports compiling with
Copy link
Contributor

Choose a reason for hiding this comment

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

Probably need replacing 'RENNAMEME' with OpenSearch

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed, thanks.

Expand All @@ -86,7 +86,7 @@ be used to test against other JDKs as well, this is not only limited to JDK 8.
> Note: It is also required to have `JAVA8_HOME`, `JAVA9_HOME`, `JAVA10_HOME`
and `JAVA11_HOME`, and `JAVA12_HOME` available so that the tests can pass.

RENAMEME uses the Gradle wrapper for its build. You can execute Gradle
OpenSearch uses the Gradle wrapper for its build. You can execute Gradle
using the wrapper via the `gradlew` script on Unix systems or `gradlew.bat`
script on Windows in the root of the repository. The examples below show the
usage on Unix.
Expand All @@ -95,19 +95,19 @@ We support development in IntelliJ versions IntelliJ 2019.2 and
onwards. We would like to support Eclipse, but few of us use it and has fallen
into [disrepair][eclipse].

[Docker](https://docs.docker.com/install/) is required for building some RENNAMEME artifacts and executing certain test suites. You can run RENAMEME without building all the artifacts with:
[Docker](https://docs.docker.com/install/) is required for building some OpenSearch artifacts and executing certain test suites. You can run OpenSearch without building all the artifacts with:

./gradlew :run

That'll spend a while building RENAMEME and then it'll start RENAMEME,
That'll spend a while building OpenSearch and then it'll start OpenSearch,
writing its log above Gradle's status message. We log a lot of stuff on startup,
specifically these lines tell you that RENAMEME is ready:
specifically these lines tell you that OpenSearch is ready:

[2020-05-29T14:50:35,167][INFO ][o.e.h.AbstractHttpServerTransport] [runTask-0] publish_address {127.0.0.1:9200}, bound_addresses {[::1]:9200}, {127.0.0.1:9200}
[2020-05-29T14:50:35,169][INFO ][o.e.n.Node ] [runTask-0] started

But to be honest its typically easier to wait until the console stops scrolling
and then run `curl` in another window like this to check if RENAMEME instance is running:
and then run `curl` in another window like this to check if OpenSearch instance is running:

RENAMEME this needs to be replaced:
CEHENKLE marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -116,7 +116,7 @@ RENAMEME this needs to be replaced:

## Java Language Formatting Guidelines

Java files in the RENAMEME codebase are formatted with the Eclipse JDT
Java files in the OpenSearch codebase are formatted with the Eclipse JDT
formatter, using the [Spotless
Gradle](https://github.com/diffplug/spotless/tree/master/plugin-gradle)
plugin. This plugin is configured on a project-by-project basis, via
Expand Down Expand Up @@ -195,12 +195,14 @@ by running Gradle with `-Dspotless.paddedcell`.
> be automatically configured to add the correct license header to new source
> files based on the source location.

## Creating A Distribution/Make a RENAMEME build
## Creating A Distribution/Make a OpenSearch build

Run all build commands from within the root directory:

RENAMEME is this right?

```sh
cd RENAMEME/
cd opensearch-project/
```

To build a darwin-tar distribution, run this command:
Expand Down Expand Up @@ -230,7 +232,7 @@ The archive distributions (tar and zip) can be found under:

## Running The Full Test Suite

**Note: RENAMEME hasn't made any changes to the test suite yet beyond fixing tests that broke after removing non-Apache licensed code and non-Apache licensed code checks**
**Note: OpenSearch hasn't made any changes to the test suite yet beyond fixing tests that broke after removing non-Apache licensed code and non-Apache licensed code checks**

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

Expand Down