Skip to content

Commit dddaaf3

Browse files
joshua-goldsteinjoshua-goldstein
authored
chore(CI): cleanup + run CI jobs with Github actions (#304)
This PR will add workflows to run Ristretto tests. It also does some basic cleanup and updates the code owners. Notable points: - go version is now pinned in .go-version and referenced by the workflow - test.sh is deprecated since it only was only relevant for TeamCity environments (it was a fancy wrapper on top of `go test -v ./...`) - ci-ristretto-tests and ci-ristretto-lint bring this repository to parity with the dgraph repository - main.yml was removed since we are no longer automatically closing issues - Coveralls now used for test coverage - Issue template updated - Pull Request template added
1 parent 1ff978f commit dddaaf3

File tree

14 files changed

+272
-50
lines changed

14 files changed

+272
-50
lines changed

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# CODEOWNERS info: https://help.github.com/en/articles/about-code-owners
22
# Owners are automatically requested for review for PRs that changes code
33
# that they own.
4-
* @manishrjain @martinmr @jarifibrahim
4+
* @akon-dey @nosql22 @joshua-goldstein @skrdgraph

‎.github/ISSUE_TEMPLATE‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: "🐞 Bug Report"
2+
description: File a bug report
3+
title: "[BUG]: <Title>"
4+
labels: ["kind/bug", "status/triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting an issue.
10+
If you suspect this could be a bug, please follow this template.
11+
- type: textarea
12+
attributes:
13+
label: What version of Ristretto are you using?
14+
description: Copy and paste the tag or commit hash used in your application's go.mod file.
15+
placeholder: |
16+
Paste here.
17+
validations:
18+
required: false
19+
- type: textarea
20+
attributes:
21+
label: What version of Go are you using?
22+
description: Copy and paste all you see using the command 'go version'.
23+
placeholder: |
24+
Paste here.
25+
validations:
26+
required: false
27+
- type: dropdown
28+
attributes:
29+
label: Have you tried reproducing the issue with the latest release?
30+
options:
31+
- "Yes"
32+
- "No"
33+
validations:
34+
required: false
35+
- type: textarea
36+
attributes:
37+
label: What is the hardware spec (RAM, CPU, OS)?
38+
description: Share all possible context of your machine.
39+
placeholder: |
40+
Type here.
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
label: What steps will reproduce the bug?
46+
description: Enter details about your bug (command/config used to set up Ristretto).
47+
placeholder: |
48+
Type here.
49+
validations:
50+
required: true
51+
- type: textarea
52+
attributes:
53+
label: Expected behavior and actual result.
54+
description: Enter details about your expectations.
55+
placeholder: |
56+
Type here.
57+
validations:
58+
required: false
59+
- type: textarea
60+
attributes:
61+
label: Additional information
62+
description: Tell us anything else you think we should know.

‎.github/ISSUE_TEMPLATE/documentation_request.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: "📃 Documentation Request"
2+
description: Suggest improvements, additions, or revisions to Ristretto documentation
3+
title: "[Documentation]: <Title>"
4+
labels: ["area/documentation", "status/triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting an issue.
10+
If you think Ristretto's documentation is lacking, please explain it here.
11+
- type: textarea
12+
attributes:
13+
label: What version of Ristretto is the target?
14+
description: Is it the latest version?
15+
placeholder: |
16+
Type here.
17+
validations:
18+
required: false
19+
- type: textarea
20+
attributes:
21+
label: Documentation.
22+
description: Explain which part of the documentation is lacking.
23+
placeholder: |
24+
Type here.
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: Additional information.
30+
description: Tell us anything else you think we should know.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "⚡ Feature Request"
2+
description: Suggest a new feature
3+
title: "[FEATURE]: <Title>"
4+
labels: ["kind/feature ", "status/triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for reporting an issue.
10+
If you think we can make Ristretto better, describe your feature request here.
11+
Note: Feature requests are judged based on user experience and modeled on
12+
[Go Experience Reports](https://github.com/golang/go/wiki/ExperienceReports).
13+
These reports should focus on the problems - they should not focus on and need not propose solutions.
14+
- type: dropdown
15+
attributes:
16+
label: Have you tried Ristretto before this proposal? and did not find anything similar?
17+
options:
18+
- "Yes"
19+
- "No"
20+
validations:
21+
required: false
22+
- type: textarea
23+
attributes:
24+
label: What you wanted to do.
25+
description: Enter details about your expectations.
26+
placeholder: |
27+
Type here.
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: What you actually did.
33+
description: Enter details about your experience with Ristretto.
34+
placeholder: |
35+
Type here.
36+
validations:
37+
required: false
38+
- type: textarea
39+
attributes:
40+
label: Why wasn't it great, with examples.
41+
description: Enter details about your expectations.
42+
placeholder: |
43+
Type here.
44+
validations:
45+
required: false
46+
- type: textarea
47+
attributes:
48+
label: Additional information.
49+
description: Any external references to support your case.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "🙋 Question"
2+
description: Question related to Ristretto
3+
title: "[QUESTION]: <Title>"
4+
labels: ["kind/question ", "status/triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
The issue tracker is primarily for code related issues, bug reports, missing documentation, or feature requests.
10+
- If you have a question, please consider asking it on https://discuss.dgraph.io
11+
- type: textarea
12+
attributes:
13+
label: Question.
14+
description: Ask your Question.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!--
2+
Change Github PR Title
3+
4+
Your title must be in the following format:
5+
- `topic(Area): Feature`
6+
- `Topic` must be one of `build|ci|docs|feat|fix|perf|refactor|chore|test`
7+
8+
Sample Titles:
9+
- `feat(Enterprise)`: Backups can now get credentials from IAM
10+
- `fix(Query)`: Skipping floats that cannot be Marshalled in JSON
11+
- `perf: [Breaking]` json encoding is now 35% faster if SIMD is present
12+
- `chore`: all chores/tests will be excluded from the CHANGELOG
13+
-->
14+
15+
## Problem
16+
<!--
17+
Please add a description with these things:
18+
1. Explain the problem by providing a good description.
19+
2. If it fixes any GitHub issues, say "Fixes #GitHubIssue".
20+
3. If it corresponds to a Jira issue, say "Fixes DGRAPH-###".
21+
4. If this is a breaking change, please prefix `[Breaking]` in the title. In the description, please put a note with exactly who these changes are breaking for.
22+
-->
23+
24+
## Solution
25+
<!--
26+
Please add a description with these things:
27+
1. Explain the solution to make it easier to review the PR.
28+
2. Make it easier for the reviewer by describing complex sections with comments.
29+
-->

‎.github/workflows/ci-ristretto-lint.yml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: ci-ristretto-lint
2+
on:
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
branches:
8+
- main
9+
schedule:
10+
- cron: "0 * * * *"
11+
jobs:
12+
go-lint:
13+
name: lint
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: golang-lint
18+
env:
19+
# prevent OOM
20+
GOGC: 10
21+
uses: golangci/golangci-lint-action@v2
22+
with:
23+
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
24+
version: v1.36
25+
only-new-issues: true
26+
args: --timeout=10m
27+
skip-go-installation: true

‎.github/workflows/ci-ristretto-tests.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: ci-ristretto-tests
2+
on:
3+
push:
4+
branches:
5+
- main
6+
pull_request:
7+
branches:
8+
- main
9+
schedule:
10+
- cron: "30 * * * *"
11+
jobs:
12+
ristretto-tests:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v3
16+
- name: Get Go Version
17+
run: |
18+
#!/bin/bash
19+
DEFAULT_VERSION="1.17"
20+
GOVERSION=$({ [ -f .go-version ] && cat .go-version; } || echo $DEFAULT_VERSION)
21+
echo "GOVERSION=$GOVERSION" >> $GITHUB_ENV
22+
- name: Setup Go
23+
uses: actions/setup-go@v3
24+
with:
25+
go-version: ${{ env.GOVERSION }}
26+
- name: Run Unit Tests
27+
run: go test -race -covermode atomic -coverprofile=covprofile ./...
28+
- name: Install Goveralls
29+
run: go install github.com/mattn/goveralls@latest
30+
- name: Send Coverage Results
31+
env:
32+
COVERALLS_TOKEN: ${{ secrets.COVERALLSIO_TOKEN }}
33+
run: goveralls -coverprofile=covprofile
34+

‎.github/workflows/main.yml‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)