Skip to content

Commit 5fb69a0

Browse files
penghuopenghuo
committed
add repo release required components
Signed-off-by: Peng Huo <[email protected]>
1 parent 574ea9c commit 5fb69a0

16 files changed

+465
-0
lines changed

‎.github/CODEWONERS

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This should match the owning team set up in https://github.com/orgs/opensearch-project/teams
2+
* @joshuali925 @dai-chen @rupal-bq @mengweieric @vamsi-amazon @penghuo @seankao-az @anirudha

‎.github/ISSUE_TEMPLATE/bug_report.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: 🐛 Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG]'
5+
labels: 'bug, untriaged'
6+
assignees: ''
7+
---
8+
9+
**What is the bug?**
10+
A clear and concise description of the bug.
11+
12+
**How can one reproduce the bug?**
13+
Steps to reproduce the behavior:
14+
1. Go to '...'
15+
2. Click on '....'
16+
3. Scroll down to '....'
17+
4. See error
18+
19+
**What is the expected behavior?**
20+
A clear and concise description of what you expected to happen.
21+
22+
**What is your host/environment?**
23+
- OS: [e.g. iOS]
24+
- Version [e.g. 22]
25+
- Plugins
26+
27+
**Do you have any screenshots?**
28+
If applicable, add screenshots to help explain your problem.
29+
30+
**Do you have any additional context?**
31+
Add any other context about the problem.

‎.github/ISSUE_TEMPLATE/config.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
contact_links:
2+
- name: OpenSearch Community Support
3+
url: https://discuss.opendistrocommunity.dev/
4+
about: Please ask and answer questions here.
5+
- name: AWS/Amazon Security
6+
url: https://aws.amazon.com/security/vulnerability-reporting/
7+
about: Please report security vulnerabilities here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 🎆 Feature request
3+
about: Request a feature in this project
4+
title: '[FEATURE]'
5+
labels: 'enhancement, untriaged'
6+
assignees: ''
7+
---
8+
**Is your feature request related to a problem?**
9+
A clear and concise description of what the problem is, e.g. _I'm always frustrated when [...]_
10+
11+
**What solution would you like?**
12+
A clear and concise description of what you want to happen.
13+
14+
**What alternatives have you considered?**
15+
A clear and concise description of any alternative solutions or features you've considered.
16+
17+
**Do you have any additional context?**
18+
Add any other context or screenshots about the feature request here.

‎.github/workflows/add-untriaged.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Apply 'untriaged' label during issue lifecycle
2+
3+
on:
4+
issues:
5+
types: [opened, reopened, transferred]
6+
7+
jobs:
8+
apply-label:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/github-script@v6
12+
with:
13+
script: |
14+
github.rest.issues.addLabels({
15+
issue_number: context.issue.number,
16+
owner: context.repo.owner,
17+
repo: context.repo.repo,
18+
labels: ['untriaged']
19+
})

‎.github/workflows/backport.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Backport
2+
on:
3+
pull_request_target:
4+
types:
5+
- closed
6+
- labeled
7+
8+
jobs:
9+
backport:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write
13+
pull-requests: write
14+
name: Backport
15+
steps:
16+
- name: GitHub App token
17+
id: github_app_token
18+
uses: tibdex/[email protected]
19+
with:
20+
app_id: ${{ secrets.APP_ID }}
21+
private_key: ${{ secrets.APP_PRIVATE_KEY }}
22+
installation_id: 22958780
23+
24+
- name: Backport
25+
uses: VachaShah/[email protected]
26+
with:
27+
github_token: ${{ steps.github_app_token.outputs.token }}
28+
head_template: backport/backport-<%= number %>-to-<%= base %>
29+
files_to_skip: 'CHANGELOG.md'

‎.github/workflows/dco.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Developer Certificate of Origin Check
2+
3+
on: [pull_request]
4+
5+
jobs:
6+
check:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- name: Get PR Commits
11+
id: 'get-pr-commits'
12+
uses: tim-actions/[email protected]
13+
with:
14+
token: ${{ secrets.GITHUB_TOKEN }}
15+
- name: DCO Check
16+
uses: tim-actions/[email protected]
17+
with:
18+
commits: ${{ steps.get-pr-commits.outputs.commits }}

‎.github/workflows/delete_backport_branch.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Delete merged branch of the backport PRs
2+
on:
3+
pull_request:
4+
types:
5+
- closed
6+
7+
jobs:
8+
delete-branch:
9+
runs-on: ubuntu-latest
10+
if: startsWith(github.event.pull_request.head.ref,'backport/')
11+
steps:
12+
- name: Delete merged branch
13+
uses: SvanBoxel/delete-merged-branch@main
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/draft-release-notes-workflow.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
update_release_draft:
10+
name: Update draft release notes
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Update draft release notes
14+
uses: release-drafter/release-drafter@v5
15+
with:
16+
config-name: draft-release-notes-config.yml
17+
name: Version (set here)
18+
tag: (None)
19+
env:
20+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/link-checker.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Link Checker
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- 'main'
8+
- '[1-9]+.[0-9x]+'
9+
10+
jobs:
11+
linkchecker:
12+
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: lychee Link Checker
18+
id: lychee
19+
uses: lycheeverse/lychee-action@master
20+
with:
21+
args: --accept=200,403,429,999 "./**/*.html" "./**/*.md" "./**/*.txt" --exclude "https://aws.oss.sonatype.*" "http://localhost*" "https://localhost" "https://odfe-node1:9200/" "https://community.tableau.com/docs/DOC-17978" ".*family.zzz" "https://pypi.python.org/pypi/opensearchsql/" "opensearch*" ".*@amazon.com" ".*email.com" "[email protected]" "http://timestamp.verisign.com/scripts/timstamp.dll" ".*/PowerBIConnector/bin/Release"
22+
env:
23+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
24+
- name: Fail if there were link errors
25+
run: exit ${{ steps.lychee.outputs.exit_code }}

‎.github/workflows/test-and-build-workflow.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
7+
jobs:
8+
build:
9+
strategy:
10+
fail-fast: false
11+
matrix:
12+
entry:
13+
- { os: ubuntu-latest, java: 11 }
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v3
18+
19+
- name: Set up JDK 11
20+
uses: actions/setup-java@v3
21+
with:
22+
distribution: 'temurin'
23+
java-version: 11
24+
25+
- name: Integ Test
26+
run: sbt integtest/test

‎CODE_OF_CONDUCT.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Code of Conduct
2+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4+
[email protected] with any additional questions or comments.

‎CONTRIBUTING.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4+
documentation, we greatly value feedback and contributions from our community.
5+
6+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7+
information to effectively respond to your bug report or contribution.
8+
9+
10+
## Reporting Bugs/Feature Requests
11+
12+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13+
14+
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16+
17+
* A reproducible test case or series of steps
18+
* The version of our code being used
19+
* Any modifications you've made relevant to the bug
20+
* Anything unusual about your environment or deployment
21+
22+
23+
## Contributing via Pull Requests
24+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25+
26+
1. You are working against the latest source on the *main* branch.
27+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
29+
30+
To send us a pull request, please:
31+
32+
1. Fork the repository.
33+
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34+
3. Ensure local tests pass.
35+
4. Commit to your fork using clear commit messages.
36+
5. Send us a pull request, answering any default questions in the pull request interface.
37+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38+
39+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41+
42+
43+
## Finding contributions to work on
44+
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.
45+
46+
47+
## Code of Conduct
48+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50+
[email protected] with any additional questions or comments.
51+
52+
53+
## Security issue notifications
54+
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.
55+
56+
57+
## Licensing
58+
59+
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

0 commit comments

Comments
 (0)