Skip to content

Commit ffc72a6

Browse files
philippemnoelphilippemnoel
authored
ci: Add missing .github community files and shared workflows (#11)
2 parents 15154b2 + 956bb25 commit ffc72a6

17 files changed

Lines changed: 620 additions & 0 deletions

‎.codespellignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
runnning
2+
runn
3+
runing
4+
shose

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Order is important. The last matching pattern has the most precedence
2+
3+
* @philippemnoel @rebasedming @mdashti @ankitml @stuhood

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: [paradedb] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Bug report
2+
description: Create a report to help us improve.
3+
labels:
4+
- bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: "### Bug Report"
9+
- type: markdown
10+
attributes:
11+
value: >
12+
Please report security vulnerabilities using GitHub's [report vulnerability form](https://github.com/paradedb/sqlalchemy-paradedb/security/advisories/new).
13+
- type: textarea
14+
attributes:
15+
label: What happens?
16+
description: A short, clear and concise description of the bug.
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: To Reproduce
22+
description: |
23+
Please provide steps to reproduce the behaviour, preferably a [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example).
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Environment
29+
description: |
30+
Please provide details about your environment:
31+
- Python version
32+
- SQLAlchemy version
33+
- sqlalchemy-paradedb version
34+
- PostgreSQL version
35+
- pg_search extension version
36+
validations:
37+
required: true
38+
- type: checkboxes
39+
attributes:
40+
label: Confirmation
41+
options:
42+
- label: I have searched for existing issues that might cover this bug.
43+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/paradedb/paradedb/discussions
5+
about: Please ask and answer general questions here.
6+
- name: ParadeDB Community Slack
7+
url: https://join.slack.com/t/paradedbcommunity/shared_invite/zt-32abtyjg4-yoYoi~RPh9MSW8tDbl0BQw
8+
about: Our Slack community is the best place to get quick help and feedback.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Feature request
2+
description: Suggest an idea for this project.
3+
labels:
4+
- feature
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: What feature are you requesting?
9+
validations:
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: Why are you requesting this feature?
14+
validations:
15+
required: true
16+
- type: textarea
17+
attributes:
18+
label: What is your proposed implementation for this feature?
19+
validations:
20+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Ticket(s) Closed
2+
3+
- Closes #
4+
5+
## What
6+
7+
## Why
8+
9+
## How
10+
11+
## Tests

‎.github/dependabot.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
version: 2
2+
3+
updates:
4+
- package-ecosystem: "github-actions"
5+
directory: "/"
6+
schedule:
7+
interval: "monthly"
8+
ignore:
9+
- dependency-name: "*"
10+
update-types: ["version-update:semver-patch"]
11+
groups:
12+
github-actions-dependencies:
13+
patterns:
14+
- "*"
15+
16+
- package-ecosystem: "pip"
17+
directory: "/"
18+
schedule:
19+
interval: "monthly"
20+
ignore:
21+
- dependency-name: "*"
22+
update-types: ["version-update:semver-patch"]
23+
groups:
24+
pip-dependencies:
25+
patterns:
26+
- "*"

‎.github/workflows/assign-github-issue.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# workflows/assign-github-issue.yml
2+
#
3+
# Assign GitHub Issue
4+
# Automatically assign an issue to the commenter if they use the '/take' command.
5+
6+
name: Assign GitHub Issue
7+
8+
on:
9+
issue_comment:
10+
types: [created]
11+
12+
# Required to assign the issue to the commenter
13+
permissions:
14+
issues: write
15+
16+
concurrency:
17+
group: assign-github-issue-${{ github.workflow }}-${{ github.event.issue.number }}
18+
cancel-in-progress: true
19+
20+
jobs:
21+
assign-github-issue:
22+
name: Assign GitHub Issue to Commenter
23+
runs-on: ubuntu-latest
24+
if: |
25+
!github.event.issue.pull_request &&
26+
contains(github.event.comment.body, '/take')
27+
28+
steps:
29+
- name: Check if Commenter Can Be Assigned
30+
id: check_assignee
31+
run: |
32+
HTTP_CODE=$(curl -X GET \
33+
-H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
34+
-H "Accept: application/vnd.github.v3+json" \
35+
-o /dev/null -w '%{http_code}\n' -s \
36+
"https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.issue.number }}/assignees/${{ github.event.comment.user.login }}")
37+
38+
if [ "$HTTP_CODE" -eq "204" ]; then
39+
echo "can_assign=true" >> $GITHUB_OUTPUT
40+
else
41+
echo "can_assign=false" >> $GITHUB_OUTPUT
42+
fi
43+
44+
- name: Assign GitHub Issue
45+
if: steps.check_assignee.outputs.can_assign == 'true'
46+
run: |
47+
curl -X POST \
48+
-H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
49+
-H "Accept: application/vnd.github.v3+json" \
50+
-d '{"assignees": ["${{ github.event.comment.user.login }}"]}' \
51+
"https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.issue.number }}/assignees"
52+
53+
echo "Issue #${{ github.event.issue.number }} assigned to ${{ github.event.comment.user.login }}"
54+
55+
- name: Notify of Assignment Failure
56+
if: steps.check_assignee.outputs.can_assign == 'false'
57+
uses: actions/github-script@v8
58+
with:
59+
github-token: ${{secrets.GITHUB_TOKEN}}
60+
script: |
61+
github.rest.issues.createComment({
62+
issue_number: context.issue.number,
63+
owner: context.repo.owner,
64+
repo: context.repo.name,
65+
body: '@${{ github.event.comment.user.login }} Unable to assign this issue to you. You may not have the necessary permissions.'
66+
})

‎.github/workflows/check-typo.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# workflows/check-typo.yml
2+
#
3+
# Check Typo
4+
# Check Typo using codespell.
5+
6+
name: Check Typo
7+
8+
on:
9+
pull_request:
10+
types: [opened, synchronize, reopened, ready_for_review]
11+
workflow_dispatch:
12+
13+
concurrency:
14+
group: check-typo-${{ github.head_ref || github.ref }}
15+
cancel-in-progress: true
16+
17+
jobs:
18+
check-typo:
19+
name: Check Typo using codespell
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- name: Checkout Git Repository
24+
uses: actions/checkout@v6
25+
26+
# The `skip` parameter is a total mess, read up before adding.
27+
# https://github.com/codespell-project/codespell/issues/1915
28+
- name: Check Typo using codespell
29+
uses: codespell-project/actions-codespell@v2
30+
with:
31+
check_filenames: true
32+
ignore_words_file: .codespellignore

0 commit comments

Comments
 (0)