Merge branch 'main' of https://github.com/nung22/dashboards-search-re…

…levance into fix/add-searchbar-id
nung22 · Nov 12, 2023 · 0d821cb · 0d821cb
2 parents af2a861 + 9e7923a
commit 0d821cb
Show file tree

Hide file tree

Showing 3 changed files with 134 additions and 29 deletions.
diff --git a/.github/workflows/dco.yml b/.github/workflows/dco.yml
diff --git a/.github/workflows/test-and-build.yml b/.github/workflows/test-and-build.yml
@@ -6,10 +6,93 @@ env:
   PLUGIN_NAME: dashboards-search-relevance
 
 jobs:
-  build:
+  Get-CI-Image-Tag:
+    uses: opensearch-project/opensearch-build/.github/workflows/get-ci-image-tag.yml@main
+    with:
+      product: opensearch-dashboards
+
+  build-linux:
+    needs: Get-CI-Image-Tag
+    runs-on: ubuntu-latest
+    container:
+      # using the same image which is used by opensearch-build team to build the OpenSearch Distribution
+      # this image tag is subject to change as more dependencies and updates will arrive over time
+      image: ${{ needs.Get-CI-Image-Tag.outputs.ci-image-version-linux }}
+      # need to switch to root so that github actions can install runner binary on container without permission issues.
+      options: --user root
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Fetch Version Information
+        shell: bash
+        run: |
+          OPENSEARCH_PLUGIN_VERSION=$(node -p "require('./package.json').version")
+          if [[ "${{ github.event_name }}" == "push" ]]; then 
+            pr_number=$(curl -sSL -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+                "https://api.github.com/repos/${{ github.repository }}/commits/${{ github.sha }}/pulls" \
+                | jq -r '.[0].number')
+            url_number=$(curl -sSL -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+                "https://api.github.com/repos/${{ github.repository }}/commits/${{ github.sha }}/pulls" \
+                | jq -r '.[0].url')
+            pr_data=$(curl -sSL -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+                "$url_number")
+            echo "BRANCH_NAME is $BRANCH_NAME"
+          elif [[ "${{ github.event_name }}" == "pull_request" ]]; then
+            echo "Base branch name is "${{ github.event.pull_request.base.ref }}""
+            BRANCH_NAME="${{ github.event.pull_request.base.ref }}"
+          fi  
+          echo "Target branch: $BRANCH_NAME"
+          echo "OPENSEARCH_PLUGIN_VERSION=$OPENSEARCH_PLUGIN_VERSION" >> $GITHUB_ENV
+          echo "OPENSEARCH_VERSION=$BRANCH_NAME" >> $GITHUB_ENV
+
+      - name: Checkout Dashboards Search Relevance plugin
+        uses: actions/checkout@v3
+        with:
+          path: dashboards-search-relevance
+
+      - name: Checkout OpenSearch Dashboards
+        uses: actions/checkout@v3
+        with:
+          repository: opensearch-project/OpenSearch-Dashboards
+          ref: ${{ env.OPENSEARCH_VERSION }}
+          path: OpenSearch-Dashboards
+
+      - name: Move Search Relevance to Plugins Dir
+        run: mv dashboards-search-relevance OpenSearch-Dashboards/plugins/dashboards-search-relevance
+
+      - name: Plugin Bootstrap / test
+        run: |
+          chown -R 1000:1000 `pwd`
+          cd ./OpenSearch-Dashboards/
+          su `id -un 1000` -c "source $NVM_DIR/nvm.sh && nvm use && node -v && yarn -v &&
+                               cd ./plugins/dashboards-search-relevance &&
+                               whoami && yarn osd bootstrap && yarn test --coverage"
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v1
+        with:
+          flags: dashboards-search-relevance
+          directory: ./OpenSearch-Dashboards/plugins/dashboards-search-relevance
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Build Artifact
+        run: |
+          chown -R 1000:1000 `pwd`
+          cd ./OpenSearch-Dashboards/
+          su `id -un 1000` -c "source $NVM_DIR/nvm.sh && nvm use && node -v && yarn -v &&
+                               cd ./plugins/dashboards-search-relevance &&
+                               whoami && yarn build && mv -v ./build/*.zip ./build/${{ env.PLUGIN_NAME }}-${{ env.OPENSEARCH_PLUGIN_VERSION }}.zip"
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v1
+        with:
+          name: dashboards-search-relevance-${{ matrix.os }}
+          path: ./OpenSearch-Dashboards/plugins/dashboards-search-relevance/build
+
+  build-macos-windows:
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -81,14 +164,6 @@ jobs:
           cd OpenSearch-Dashboards/plugins/dashboards-search-relevance
           yarn test --coverage
 
-      - name: Upload coverage
-        if: ${{ matrix.os == 'ubuntu-latest' }}
-        uses: codecov/codecov-action@v1
-        with:
-          flags: dashboards-search-relevance
-          directory: ./OpenSearch-Dashboards/plugins/dashboards-search-relevance
-          token: ${{ secrets.CODECOV_TOKEN }}
-
       - name: Build Artifact
         run: |
           cd OpenSearch-Dashboards/plugins/dashboards-search-relevance
@@ -99,4 +174,4 @@ jobs:
         uses: actions/upload-artifact@v1
         with:
           name: dashboards-search-relevance-${{ matrix.os }}
-          path: ./OpenSearch-Dashboards/plugins/dashboards-search-relevance/build
+          path: ./OpenSearch-Dashboards/plugins/dashboards-search-relevance/build
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,6 +21,7 @@ reported the issue. Please try to include as much information as you can. Detail
 
 
 ## Contributing via Pull Requests
+
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
 1. You are working against the latest source on the *main* branch.
@@ -41,16 +42,63 @@ GitHub provides additional document on [forking a repository](https://help.githu
 
 
 ## Finding contributions to work on
+
 Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
 
+## Developer Certificate of Origin
+
+OpenSearch is an open source product released under the Apache 2.0 license (see either [the Apache site](https://www.apache.org/licenses/LICENSE-2.0) or the [LICENSE.txt file](./LICENSE.txt)). The Apache 2.0 license allows you to freely use, modify, distribute, and sell your own products that include Apache 2.0 licensed software.
+
+We respect intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that.
+
+The DCO is a declaration attached to every contribution made by every developer. In the commit message of the contribution, the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/).
+
+```
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the
+    best of my knowledge, is covered under an appropriate open
+    source license and I have the right under that license to
+    submit that work with modifications, whether created in whole
+    or in part by me, under the same open source license (unless
+    I am permitted to submit under a different license), as
+    Indicated in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including
+    all personal information I submit with it, including my
+    sign-off) is maintained indefinitely and may be redistributed
+    consistent with this project or the open source license(s)
+    involved.
+ ```
+We require that every contribution to OpenSearch is signed with a Developer Certificate of Origin. Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms.
+
+Each commit must include a DCO which looks like this
+
+```
+Signed-off-by: Jane Smith <jane.smith@email.com>
+```
+You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `--signoff` to add the `Signed-off-by` line to the end of the commit message.
 
 ## Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
 opensource-codeofconduct@amazon.com with any additional questions or comments.
 
 
 ## Security issue notifications
+
 If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.