Skip to content

Commit 5d10dcb

Browse files
ohltylerohltyler
authored
Add initial config files and workflows (#2)
Signed-off-by: Tyler Ohlsen <ohltyler@amazon.com>
1 parent 11a33af commit 5d10dcb

23 files changed

+811
-65
lines changed

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @dbwiddis @owaiskazi19 @joshpalis @ohltyler @amitgalitz @jackiehanyang

‎.github/ISSUE_TEMPLATE/bug_report.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
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+
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**What is the expected behavior?**
21+
A clear and concise description of what you expected to happen.
22+
23+
**What is your host/environment?**
24+
25+
- OS: [e.g. iOS]
26+
- Version [e.g. 22]
27+
- Plugins
28+
29+
**Do you have any screenshots?**
30+
If applicable, add screenshots to help explain your problem.
31+
32+
**Do you have any additional context?**
33+
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

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

‎.github/draft-release-notes-config.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# The overall template of the release notes
2+
template: |
3+
Compatible with OpenSearch Dashboards (**set version here**).
4+
$CHANGES
5+
6+
# Setting the formatting and sorting for the release notes body
7+
name-template: Version (set version here)
8+
change-template: '* $TITLE ([#$NUMBER]($URL))'
9+
sort-by: merged_at
10+
sort-direction: ascending
11+
replacers:
12+
- search: '##'
13+
replace: '###'
14+
15+
# Organizing the tagged PRs into unified OpenSearch categories
16+
categories:
17+
- title: 'Breaking changes'
18+
labels:
19+
- 'breaking change'
20+
- title: 'Features'
21+
labels:
22+
- 'feature'
23+
- title: 'Enhancements'
24+
labels:
25+
- 'enhancement'
26+
- title: 'Bug Fixes'
27+
labels:
28+
- 'bug'
29+
- 'bug fix'
30+
- title: 'Infrastructure'
31+
labels:
32+
- 'infra'
33+
- 'test'
34+
- 'dependencies'
35+
- 'github actions'
36+
- title: 'Documentation'
37+
labels:
38+
- 'documentation'
39+
- title: 'Maintenance'
40+
labels:
41+
- 'version upgrade'
42+
- 'opensearch release'
43+
- title: 'Refactoring'
44+
labels:
45+
- 'refactor'
46+
- 'code quality'

‎.github/labeler.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Default all changes to backporting to 2.x branch
2+
backport 2.x:
3+
- '*'
4+
- '*/*'
5+
- '*/**/*'
6+
- '*/**/**/*'
7+
- '*/**/**/**/*'
8+
- '*/**/**/**/**/*'
9+
- '*/**/**/**/**/**/*'
10+
- '*/**/**/**/**/**/**/*'
11+
- '*/**/**/**/**/**/**/**/*'
12+
- '*/**/**/**/**/**/**/**/**/*'
13+
- '.github/**/*'
14+
15+
# Adding "github actions" label to files in .github or its subdirectories
16+
github actions:
17+
- '.github/**/*'
18+
19+
# Adding "documentation" label to markdown files or updating release notes
20+
documentation:
21+
- '*.md'
22+
- 'release-notes/*'
23+
24+
# Adding a "dependencies" label when yarn.lock is updated
25+
dependencies:
26+
- 'yarn.lock'

‎.github/pull_request_template.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
### Description
2+
3+
[Describe what this change achieves]
4+
5+
### Issues Resolved
6+
7+
[List any issues this PR will resolve]
8+
9+
### Check List
10+
11+
- [ ] New functionality includes testing.
12+
- [ ] All tests pass
13+
- [ ] New functionality has been documented.
14+
- [ ] Commits are signed per the DCO using `--signoff`
15+
16+
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
17+
For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).

‎.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

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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/github-app-token@v1.5.0
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/backport@v1.1.4
26+
with:
27+
github_token: ${{ steps.github_app_token.outputs.token }}
28+
branch_name: backport/backport-${{ github.event.number }}

‎.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

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

‎.github/workflows/labeler.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: "Pull Request Labeler"
2+
on:
3+
pull_request_target:
4+
branches:
5+
- main
6+
types:
7+
- opened
8+
9+
jobs:
10+
label:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: write
14+
pull-requests: write
15+
steps:
16+
- name: GitHub App token
17+
id: github_app_token
18+
uses: tibdex/github-app-token@v1.5.0
19+
with:
20+
app_id: ${{ secrets.APP_ID }}
21+
private_key: ${{ secrets.APP_PRIVATE_KEY }}
22+
installation_id: 22958780
23+
- name: Label
24+
uses: actions/labeler@v4
25+
with:
26+
repo-token: ${{ steps.github_app_token.outputs.token }}

‎.github/workflows/link-check-workflow.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Link Checker
2+
on:
3+
push:
4+
branches: [main]
5+
pull_request:
6+
branches: [main]
7+
8+
jobs:
9+
linkchecker:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: lychee Link Checker
15+
id: lychee
16+
uses: lycheeverse/lychee-action@master
17+
with:
18+
args: --accept=200,403,429 --exclude=localhost **/*.html **/*.md **/*.txt **/*.json
19+
env:
20+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
21+
- name: Fail if there were link errors
22+
run: exit ${{ steps.lychee.outputs.exit_code }}

‎.gitignore

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
npm-debug.log*
2+
node_modules
3+
/build/
4+
build
5+
*.iml
6+
*.ipr
7+
*.iws
8+
.idea/
9+
.DS_Store
10+
*.sublime*
11+
.opensearch-dashboards-plugin-helpers.dev.json
12+
coverage
13+
.vscode
14+
*.code-workspace
15+
offline-module-cache/v2/*
16+
offline-module-cache/v1/*
17+
target
18+
._.DS_Store

‎.prettierignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.yml
2+
release-notes/
3+
*.config

‎.prettierrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"trailingComma": "es5",
3+
"singleQuote": true,
4+
"printWidth": 80
5+
}

‎CONTRIBUTING.md

+3-58
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,4 @@
1-
# Contributing Guidelines
1+
## Contributing to this Project
22

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-
opensource-codeofconduct@amazon.com 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.
3+
OpenSearch is a community project that is built and maintained by people just like **you**.
4+
[This document](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md) explains how you can contribute to this and related projects.

0 commit comments

Comments
 (0)