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

2.7 #14

Closed
wants to merge 81 commits into from
Closed

2.7 #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
79d09b3
Fixed github deploy
aparo Jan 30, 2022
048f661
fix licenses, comment out nebula check
gsingers Sep 6, 2022
5670372
upgrade gradle and upgrade OpenSearch version
gsingers Sep 7, 2022
f69c4ab
begin fixing compile errors, only thing left are Query.visit() method…
gsingers Sep 7, 2022
8f0dea2
it compiles
gsingers Sep 7, 2022
51ed085
The original plugin powers Wikimedia, not the fork (#1)
flaxsearch Sep 7, 2022
ad951de
Add id back to index request, remove mapping type param from YAML tes…
mkr Sep 13, 2022
aa8d889
update java version in workflows and start updating the readme
gsingers Sep 13, 2022
072a6df
update to main branch
gsingers Sep 13, 2022
ed267cb
add sec manager flag
gsingers Sep 13, 2022
2e9a7b0
add test target to gh action
gsingers Sep 13, 2022
3dd5cf7
fix environment vars
gsingers Sep 13, 2022
22098a0
turn off sec. mgr in the dist
gsingers Sep 13, 2022
0849692
add permissions
gsingers Sep 13, 2022
74219e7
attempt permissions
gsingers Sep 13, 2022
a0e27c9
try new release action
gsingers Sep 15, 2022
bccfd10
add branch for testing
gsingers Sep 15, 2022
db938c1
remove tag-name
gsingers Sep 15, 2022
5dcf967
clean up tags
gsingers Sep 15, 2022
bf836e2
tag
gsingers Sep 15, 2022
baedeb5
upload release asset fixes
gsingers Sep 15, 2022
c799ace
release tag name
gsingers Sep 15, 2022
b78765e
tag name for upload
gsingers Sep 15, 2022
34b5367
test release
gsingers Sep 15, 2022
e8abfe1
Docker (#5)
gsingers Sep 15, 2022
6ee8fd0
fix build-args
gsingers Sep 15, 2022
7466f46
fix build-args, but this time try harder
gsingers Sep 15, 2022
9cfdef6
docker tweaks
gsingers Sep 15, 2022
cee48fe
rc
gsingers Sep 15, 2022
a03a540
ARGGGGGGGG
gsingers Sep 15, 2022
2a18668
would help if we got the version/path right
gsingers Sep 15, 2022
3ae786b
upgrades for 2.5.0: new versions of things, add some docs, upgrade gr…
gsingers Jan 31, 2023
e6fc046
update versions, add some more readme
gsingers Jan 31, 2023
d72ee5f
push version
gsingers Jan 31, 2023
753ab7d
adding standard OpenSearch issue templates and ADMIN/MAINTAINERS/CODE…
macohen Jun 14, 2023
753b858
replacing .github repo references with refs to this repo
macohen Jun 14, 2023
9fea2ec
adding standard opensearch code of conduct
macohen Jun 15, 2023
2c0bf1c
adding Grant Ingersoll as a maintainer
macohen Jun 29, 2023
ac38ec7
Add .whitesource configuration file
mend-for-github-com[bot] Jun 13, 2023
0c04830
starting to build against OpenSearch 2.7.0 with several updates in co…
macohen Jul 10, 2023
cee4d45
updated according to changes in OpenSearch core; added integTests and…
macohen Jul 11, 2023
4690278
new ci build for opensearch
macohen Jul 11, 2023
44a857d
removed windows build and added workflow_dispatch
macohen Jul 11, 2023
2c9a9f9
removed windows build and added workflow_dispatch
macohen Jul 11, 2023
9966a3e
updated CI to upload build artifacts
macohen Jul 12, 2023
27232cd
commented codecov in ci.yml for now
macohen Jul 14, 2023
1596e94
added 'github.ref
macohen Jul 16, 2023
ceefb87
updated gradle command to be consistent with updates in build.gradle
macohen Jul 16, 2023
b4be3c3
removed test-release branch
macohen Jul 16, 2023
271c831
removed space from line 9 in release.yml
macohen Jul 16, 2023
6cec473
updated README.md with 2.7.0 build info; removed KNOWN_ISSUES.md; set…
macohen Aug 4, 2023
dac6ab4
yamlRestTest was failing on naming of snapshots so I may have made th…
macohen Sep 4, 2023
af9f676
fix: revert build.gradle sourceSets changes
hasnain2808 Sep 27, 2023
2085050
Rebased to sign-off on prior commits
gsingers Sep 15, 2022
e916af5
Docker (#5)
gsingers Sep 15, 2022
563a3d3
fix build-args
gsingers Sep 15, 2022
ff7ab03
updated Dockerfile for new versioning
gsingers Sep 15, 2022
d9c7d30
would help if we got the version/path right
gsingers Sep 15, 2022
ff51356
upgrades for 2.5.0: new versions of things, add some docs, upgrade gr…
gsingers Jan 31, 2023
6e00d5d
update versions, add some more readme
gsingers Jan 31, 2023
be71e06
starting to build against OpenSearch 2.7.0 with several updates in co…
macohen Jul 10, 2023
8f1f53a
updated according to changes in OpenSearch core; added integTests and…
macohen Jul 11, 2023
ef5bf71
new ci build for opensearch
macohen Jul 11, 2023
d8bf026
removed windows build and added workflow_dispatch
macohen Jul 11, 2023
b631848
removed windows build and added workflow_dispatch
macohen Jul 11, 2023
e6ece09
updated CI to upload build artifacts
macohen Jul 12, 2023
7e1feae
commented codecov in ci.yml for now
macohen Jul 14, 2023
d32ed8c
added 'github.ref
macohen Jul 16, 2023
c8c6c3d
updated gradle command to be consistent with updates in build.gradle
macohen Jul 16, 2023
002d733
removed test-release branch
macohen Jul 16, 2023
f9d372a
removed space from line 9 in release.yml
macohen Jul 16, 2023
737b9d6
updated README.md with 2.7.0 build info; removed KNOWN_ISSUES.md; set…
macohen Aug 4, 2023
dce0060
yamlRestTest was failing on naming of snapshots so I may have made th…
macohen Sep 4, 2023
2723216
fix: revert build.gradle sourceSets changes
hasnain2808 Sep 27, 2023
9060f68
any new issues should have an 'untriaged' label added by default to c…
macohen Jul 11, 2023
851bb3a
cleaning up release-old.yml
macohen Nov 12, 2023
bba773f
updated the 2.7.0 compatible plugin release and noted that publish to…
macohen Nov 13, 2023
32a343e
updated README.md; build.gradle runs integtests now; updated Learning…
macohen Nov 13, 2023
776bfb5
updated GH workflow to not skip integ tests
macohen Nov 13, 2023
a6c9cbe
updated build scripts for 2.7.0; ltr version matches OpenSearch version
macohen Jan 14, 2024
6d4d10b
running build for all PRs in GH actions
macohen Jan 15, 2024
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
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @gsingers @macohen
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
title: '[BUG]'
labels: 'bug, untriaged'
assignees: ''
---
### What is the bug?
_A clear and concise description of the bug._

### How can one reproduce the bug?
_Steps to reproduce the behavior._

### What is the expected behavior?
_A clear and concise description of what you expected to happen._

### What is your host/environment?
_Operating system, version._

### Do you have any screenshots?
_If applicable, add screenshots to help explain your problem._

### Do you have any additional context?
_Add any other context about the problem._
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: 🎆 Feature request
about: Request a feature in this project
title: '[FEATURE]'
labels: 'enhancement, untriaged'
assignees: ''
---
### Is your feature request related to a problem?
_A clear and concise description of what the problem is, e.g. I'm always frustrated when [...]._

### What solution would you like?
_A clear and concise description of what you want to happen._

### What alternatives have you considered?
_A clear and concise description of any alternative solutions or features you've considered._

### Do you have any additional context?
_Add any other context or screenshots about the feature request here._
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/PROPOSAL_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: 💭 Proposal
about: Suggest an idea for a specific feature you wish to propose to the community for comment
title: '[PROPOSAL]'
labels: proposal
assignees: ''
---
## What/Why
### What are you proposing?
_In a few sentences, describe the feature and its core capabilities._

### What users have asked for this feature?
_Highlight any research, proposals, requests or anecdotes that signal this is the right thing to build. Include links to GitHub Issues, Forums, Stack Overflow, Twitter, Etc_

### What problems are you trying to solve?
_Summarize the core use cases and user problems and needs you are trying to solve. Describe the most important user needs, pain points and jobs as expressed by the user asks above. Template: When \<a situation arises> , a \<type of user> wants to \<do something>, so they can \<expected outcome>. (Example: When **searching by postal code**, **a buyer** wants to **be required to enter a valid code** so they **don’t waste time searching for a clearly invalid postal code.**)_

### What is the developer experience going to be?
_Does this have a REST API? If so, please describe the API and any impact it may have to existing APIs. In a brief summary (not a spec), highlight what new REST APIs or changes to REST APIs are planned. as well as any other API, CLI or Configuration changes that are planned as part of this feature._

#### Are there any security considerations?
_Describe if the feature has any security considerations or impact. What is the security model of the new APIs? Features should be integrated into the OpenSearch security suite and so if they are not, we should highlight the reasons here._

#### Are there any breaking changes to the API
_If this feature will require breaking changes to any APIs, ouline what those are and why they are needed. What is the path to minimizing impact? (example, add new API and deprecate the old one)_

### What is the user experience going to be?
_Describe the feature requirements and or user stories. You may include low-fidelity sketches, wireframes, APIs stubs, or other examples of how a user would use the feature via CLI, OpenSearch Dashboards, REST API, etc. Using a bulleted list or simple diagrams to outline features is okay. If this is net new functionality, call this out as well._

#### Are there breaking changes to the User Experience?
_Will this change the existing user experience? Will this be a breaking change from a user flow or user experience perspective?_

### Why should it be built? Any reason not to?
_Describe the value that this feature will bring to the OpenSearch community, as well as what impact it has if it isn't built, or new risks if it is. Highlight opportunities for additional research._

### What will it take to execute?
_Describe what it will take to build this feature. Are there any assumptions you may be making that could limit scope or add limitations? Are there performance, cost, or technical constraints that may impact the user experience? Does this feature depend on other feature work? What additional risks are there?_

### Any remaining open questions?
_What are known enhancements to this feature? Any enhancements that may be out of scope but that we will want to track long term? List any other open questions that may need to be answered before proceeding with an implementation._
7 changes: 7 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: OpenSearch Community Support
url: https://forum.opensearch.org
about: Please ask and answer questions here.
- name: AWS/Amazon Security
url: https://aws.amazon.com/security/vulnerability-reporting/
about: Please report security vulnerabilities here.
19 changes: 19 additions & 0 deletions .github/workflows/add-untriaged-label.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Apply 'untriaged' label during issue lifecycle

on:
issues:
types: [opened, transferred]

jobs:
apply-label:
runs-on: ubuntu-latest
steps:
- uses: actions/github-script@v6
with:
script: |
github.rest.issues.addLabels({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ['untriaged']
})
49 changes: 49 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Build & Test Learning to Rank Plugin

on:
schedule:
- cron: '0 0 * * *' # every night
push:
pull_request:
workflow_dispatch:

jobs:
build-ltr-plugin:
strategy:
matrix:
java: [11, 17]
os: [ubuntu-latest, macos-latest]

name: Build and Test Learning to Rank Plugin
runs-on: ${{ matrix.os }}

steps:
- name: Checkout LTR Plugin
uses: actions/checkout@v1

- name: Setup Java ${{ matrix.java }}
uses: actions/setup-java@v1
with:
java-version: ${{ matrix.java }}

- name: Run non-Windows
if: ${{ matrix.os != 'windows-latest' }}
run: |
./gradlew -Dopensearch.version=2.7.0 -Djava.security.manager=allow -Dbuild.snapshot=false -Dtests.security.manager=false clean build test

# - name: Upload Coverage Report
# if: ${{matrix.os}} == 'ubuntu'
# uses: codecov/codecov-action@v1
# with:
# token: ${{ secrets.CODECOV_TOKEN }}

- name: Create Artifact Path
run: |
mkdir -p opensearch-ltr-builds
cp -r ./build/distributions/*.zip opensearch-ltr-builds

- name: Upload Artifacts
uses: actions/upload-artifact@v1
with:
name: opensearch-ltr-${{ matrix.os }}
path: opensearch-ltr-builds
41 changes: 41 additions & 0 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Publish a Docker Image

on:
release:
types: [published]
workflow_dispatch:
inputs:
opensearch-version:
description: 'OpenSearch Version to use'
required: true
default: 2.7.0
ltrversion:
description: 'LTR Plugin Version'
required: true
default: 2.7.0


jobs:
build_push_image:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Set up Docker Buildx
id: setup-docker-buildx
uses: docker/setup-buildx-action@v2
- name: Login to DockerHub
uses: docker/login-action@v2
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push
uses: docker/build-push-action@v3
with:
file: docker/Dockerfile
build-args: |
opensearch_version=${{inputs.opensearch-version}}
ltrversion=${{inputs.ltrversion}}
push: true
tags: opensearch-project/opensearch-learning-to-rank:${{inputs.ltrversion}}
github-token: ${{ secrets.GITHUB_TOKEN }}
47 changes: 0 additions & 47 deletions .github/workflows/release.yml

This file was deleted.

10 changes: 5 additions & 5 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ name: Run CI tests with Gradle

on:
push:
branches: [ master ]
branches: [main]
pull_request:
branches: [ master ]
branches: [main]

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up JDK 14.0
- name: Set up JDK 17.0
uses: actions/setup-java@v1
with:
java-version: 14.0
java-version: 17.0
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Build with Gradle
run: ./gradlew clean check
run: ./gradlew -Dtests.security.manager=false clean test
33 changes: 33 additions & 0 deletions .whitesource
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"scanSettings": {
"configMode": "AUTO",
"configExternalURL": "",
"projectToken": "",
"baseBranches": []
},
"scanSettingsSAST": {
"enableScan": false,
"scanPullRequests": false,
"incrementalScan": true,
"baseBranches": [],
"snippetSize": 10
},
"checkRunSettings": {
"vulnerableCheckRunConclusionLevel": "failure",
"displayMode": "diff",
"useMendCheckNames": true
},
"checkRunSettingsSAST": {
"checkRunConclusionLevel": "failure",
"severityThreshold": "high"
},
"issueSettings": {
"minSeverityLevel": "LOW",
"issueType": "DEPENDENCY"
},
"remediateSettings": {
"workflowRules": {
"enabled": true
}
}
}
39 changes: 39 additions & 0 deletions ADMIN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
- [Overview](#overview)
- [Current Admins](#current-admins)
- [Admin Responsibilities](#admin-responsibilities)
- [Prioritize Security](#prioritize-security)
- [Enforce Code of Conduct](#enforce-code-of-conduct)
- [Add/Remove Maintainers](#addremove-maintainers)
- [Adopt Organizational Best Practices](#adopt-organizational-best-practices)

## Overview

This document explains who the admins are (see below), what they do in this repo, and how they should be doing it. If you're interested in becoming a maintainer, see [MAINTAINERS](MAINTAINERS.md). If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md).

## Current Admins

| Admin | GitHub ID | Affiliation |
| ------------------ | --------------------------------------- | ----------- |
| Grant Ingersoll | [gsingers](https://github.com/gsingers) | Develomentor

## Admin Responsibilities

As an admin you own stewardship of the repository and its settings. Admins have [admin-level permissions on a repository](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization). Use those privileges to serve the community and protect the repository as follows.

### Prioritize Security

Security is your number one priority. Manage security keys and safeguard access to the repository.

Note that this repository is monitored and supported 24/7 by Amazon Security, see [Reporting a Vulnerability](SECURITY.md) for details.

### Enforce Code of Conduct

Act on [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) violations by revoking access, and blocking malicious actors.

### Add/Remove Maintainers

Perform administrative tasks, such as [adding](MAINTAINERS.md#adding-a-new-maintainer) and [removing maintainers](MAINTAINERS.md#removing-a-maintainer).

### Adopt Organizational Best Practices

Adopt organizational best practices, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project organization.
24 changes: 24 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@

This code of conduct applies to all spaces provided by the OpenSource project including in code, documentation, issue trackers, mailing lists, chat channels, wikis, blogs, social media and any other communication channels used by the project.

**Our open source communities endeavor to:**

* Be Inclusive: We are committed to being a community where everyone can join and contribute. This means using inclusive and welcoming language.
* Be Welcoming: We are committed to maintaining a safe space for everyone to be able to contribute.
* Be Respectful: We are committed to encouraging differing viewpoints, accepting constructive criticism and work collaboratively towards decisions that help the project grow. Disrespectful and unacceptable behavior will not be tolerated.
* Be Collaborative: We are committed to supporting what is best for our community and users. When we build anything for the benefit of the project, we should document the work we do and communicate to others on how this affects their work.

**Our Responsibility. As contributors, members, or bystanders we each individually have the responsibility to behave professionally and respectfully at all times. Disrespectful and unacceptable behaviors include, but are not limited to:**

* The use of violent threats, abusive, discriminatory, or derogatory language;
* Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, race, political or religious affiliation;
* Posting of sexually explicit or violent content;
* The use of sexualized language and unwelcome sexual attention or advances;
* Public or private harassment of any kind;
* Publishing private information, such as physical or electronic address, without permission;
* Other conduct which could reasonably be considered inappropriate in a professional setting;
* Advocating for or encouraging any of the above behaviors.

**Enforcement and Reporting Code of Conduct Issues:**

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported. [Contact us](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
Loading