Skip to content
This repository was archived by the owner on Dec 18, 2023. It is now read-only.

Commit dcc0d47

Browse files
ProphetLambProphetLamb
authored
Merge pull request #94 from Surreal-Net/bug/nightly_compatibility
2 parents 8269395 + 07fe37b commit dcc0d47

File tree

13 files changed

+404
-64
lines changed

13 files changed

+404
-64
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: bug_report
2+
description: File a bug report
3+
title: "Bug: "
4+
labels: ["bug", "triage"]
5+
assignees:
6+
- octocat
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
- type: textarea
13+
id: what
14+
attributes:
15+
label: Describe the bug
16+
description: What exactly is going wrong?
17+
placeholder: A short description of what the bug is.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to reproduce
24+
description: What are the steps necessary to reproduce this bug?
25+
placeholder: Detail the steps taken to reproduce the behaviour.
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: expected
30+
attributes:
31+
label: Expected behaviour
32+
description: What is the behaviour that you would expect to see?
33+
placeholder: A clear and concise description of what you expected to happen.
34+
validations:
35+
required: true
36+
- type: input
37+
id: driver_version
38+
attributes:
39+
label: Surreal.NET driver version
40+
description: The version of the NuGet package
41+
placeholder: 1.0.8
42+
validations:
43+
required: true
44+
- type: input
45+
id: db_version
46+
attributes:
47+
label: SurrealDB version
48+
description: Copy and paste the output of `surreal version`
49+
placeholder: surreal 0.0.0 for macOS on aarch64
50+
validations:
51+
required: true
52+
- type: checkboxes
53+
id: check
54+
attributes:
55+
label: Is there an existing issue for this?
56+
description: Please search [our issues](https://github.com/Surreal-Net/Surreal.Net/issues) to see if this bug already exists.
57+
options:
58+
- label: I have searched the existing issues
59+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.md

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

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question or idea
4+
url: https://github.com/Surreal-Net/Surreal.Net/discussions
5+
about: Ask questions and discuss ideas here.

‎.github/ISSUE_TEMPLATE/doc.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Documentation
2+
description: Report an issue related to documentation
3+
title: "Documentation: "
4+
labels: ["documentation", "triage"]
5+
assignees:
6+
- octocat
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to make our documentation better!
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: What should be changed in the docs?
17+
placeholder: A clear and concise description of how the documentation should be updated.
18+
validations:
19+
required: true
20+
- type: checkboxes
21+
id: check
22+
attributes:
23+
label: Is there an existing issue for this?
24+
description: Please search [our issues](https://github.com/Surreal-Net/Surreal.Net/issues) to see if this bug already exists.
25+
options:
26+
- label: I have searched the existing issues
27+
required: true

‎.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: feature_request
2+
description: File a feature request
3+
title: "Feature: "
4+
labels: ["feature", "triage"]
5+
assignees:
6+
- octocat
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to suggest an idea for SurrealDB!
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Is your feature request related to a problem?
16+
description: What is the usecase in which this feature is relevant?
17+
placeholder: A clear and concise description of what the problem is.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Describe the solution
24+
description: Describe the solution and how it might work.
25+
placeholder: A clear and concise description of what you want to happen.
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: alternatives
30+
attributes:
31+
label: Alternative methods
32+
description: Describe alternatives you've considered.
33+
placeholder: A clear and concise description of any alternative solutions or features you've considered.
34+
validations:
35+
required: true
36+
- type: input
37+
id: driver_version
38+
attributes:
39+
label: Surreal.NET driver version
40+
description: The version of the NuGet package
41+
placeholder: 1.0.8
42+
validations:
43+
required: true
44+
- type: input
45+
id: db_version
46+
attributes:
47+
label: SurrealDB version
48+
description: Copy and paste the output of `surreal version`
49+
placeholder: surreal 0.0.0 for macOS on aarch64
50+
validations:
51+
required: true
52+
- type: input
53+
id: contact
54+
attributes:
55+
label: Contact Details
56+
description: How can we get in touch with you if we need more info?
57+
placeholder: [email protected]
58+
validations:
59+
required: false
60+
- type: checkboxes
61+
id: check
62+
attributes:
63+
label: Is there an existing issue for this?
64+
description: Please search [our issues](https://github.com/Surreal-Net/Surreal.Net/issues) to see if this bug already exists.
65+
options:
66+
- label: I have searched the existing issues
67+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.md

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

‎.github/PULL_REQUEST_TEMPLATE/pull_request.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Thanks a lot for the PR! We appreciate you spending the time to work on these changes.
2+
3+
## Title
4+
5+
Prefix the type of change in the title for a concise description
6+
7+
- NEW: Add something entirely new. E.g. NEW: Add Git ignore file
8+
- IMPROVE: Improve/enhance piece of code like refactoring etc. E.g. IMPROVE: Remote IP API Function
9+
- FIX: Fix a bug — need I say more? E.g. 🐛 FIX: Case conversion
10+
- DOC: Add documentation like README.md, or even inline docs. E.g. DOC: API Interface Tutorial
11+
- TEST: Related to testing. E.g. 🤖 TEST: Mock User Login/Logout
12+
13+
---
14+
15+
## Motivation
16+
17+
Provide information on the motivation for why you have made this change.
18+
19+
## Description
20+
21+
Provide a description of what this pull request does.
22+
23+
24+
## Breaking changes
25+
26+
Provide a description of how changes to existing behavior require manual intervention for users. E.g. a method signature changed.
27+
28+
## Testing
29+
30+
For functional changes (basically everything except documentation), describe how the effect of the PR is tested.
31+
For new functionality consider adding unit tests.
32+
33+
## Issues
34+
35+
Is the PR related to an existing issue? Link related issues here.
36+
37+
-

‎.github/workflows/build-nightly.yml

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Build & Test
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- "develop"
8+
- "feature/**"
9+
paths-ignore:
10+
- ".github/**"
11+
- "docs/**"
12+
- "examples/**"
13+
- "*.md"
14+
- "*.yml"
15+
env:
16+
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
17+
DOTNET_CLI_TELEMETRY_OPTOUT: 1
18+
DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: true
19+
defaults:
20+
run:
21+
shell: bash
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
strategy:
27+
matrix:
28+
dotnet:
29+
[{ ch: "3.1", ver: "netcoreapp31" }, { ch: "6.0", ver: "net60" }]
30+
channel: ["nightly"]
31+
fail-fast: false
32+
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v3
36+
37+
- name: Initialize Cache
38+
uses: actions/cache@v3
39+
with:
40+
path: ~/.nuget/packages
41+
# Look to see if there is a cache hit for the corresponding requirements file
42+
key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
43+
restore-keys: |
44+
${{ runner.os }}-nuget
45+
46+
- name: Initialize SurrealDB
47+
run: |
48+
mkdir -p ~/.local/bin || exit 1
49+
mkdir -p ~/tmp || exit 1
50+
pushd ~/tmp || exit 1
51+
52+
curl -sSf https://install.surrealdb.com -o ./surealdb-install.sh
53+
chmod +x ./surealdb-install.sh
54+
./surealdb-install.sh ~/.local/bin --${{ matrix.channel }}
55+
export PATH="$HOME/.local/bin/:$PATH"
56+
57+
popd
58+
59+
surreal version || exit 1
60+
61+
- name: Initialize .NET SDK
62+
run: |
63+
curl https://dot.net/v1/dotnet-install.sh -o ~/dotnet-install.sh
64+
chmod +x ~/dotnet-install.sh
65+
~/dotnet-install.sh -c ${{ matrix.dotnet.ch }}
66+
dotnet --info
67+
68+
- name: Restore Dependencies
69+
run: dotnet restore
70+
71+
- name: Build Solution
72+
run: dotnet build --no-restore -f:${{ matrix.dotnet.ver }}
73+
74+
- name: Execute Unit-Tests
75+
run: |
76+
dotnet test --no-build -f:${{ matrix.dotnet.ver }} --verbosity normal --logger "trx;LogFileName=$(pwd)/test-results.trx" --collect:"XPlat Code Coverage" /p:CollectCoverage=true /p:CoverletOutputFormat=\"cobertura\" /p:CoverletOutput="$(pwd)/" /p:UseSourceLink=true
77+
78+
- name: Test Report
79+
if: success() || failure()
80+
uses: phoenix-actions/test-reporting@v8
81+
with:
82+
name: results-${{ matrix.dotnet.ver }}-${{ matrix.channel }}
83+
path: test-results.trx
84+
reporter: dotnet-trx
85+
fail-on-error: false
86+
87+
- name: Test Coverage
88+
if: ${{ github.ref == 'refs/heads/master' }}
89+
uses: codecov/codecov-action@v3
90+
with:
91+
token: ${{ secrets.CODECOV_TOKEN }}
92+
files: ./coverage.cobertura.xml
93+
flags: unittests
94+
name: Surreal.Net
95+
fail_ci_if_error: false
96+
verbose: true

‎.github/workflows/build.yml renamed to ‎.github/workflows/build-stable.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@ name: Build & Test
33
on:
44
workflow_dispatch:
55
push:
6+
branches:
7+
- "master"
8+
- "hotfix/**"
9+
paths-ignore:
10+
- ".github/**"
11+
- "docs/**"
12+
- "examples/**"
13+
- "*.md"
14+
- "*.yml"
615
env:
716
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
817
DOTNET_CLI_TELEMETRY_OPTOUT: 1
@@ -18,7 +27,7 @@ jobs:
1827
matrix:
1928
dotnet:
2029
[{ ch: "3.1", ver: "netcoreapp31" }, { ch: "6.0", ver: "net60" }]
21-
channel: ["nightly", "stable"]
30+
channel: ["stable"]
2231
fail-fast: false
2332

2433
steps:

‎.github/workflows/docs.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@ name: Documentation
22

33
on:
44
push:
5-
branches: [master]
5+
branches:
6+
- "master"
7+
- "doc/**"
68
paths-ignore:
7-
- ".github/"
8-
- "tests/"
9+
- ".github/**"
10+
- "tests/**"
911
env:
1012
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
1113
DOTNET_CLI_TELEMETRY_OPTOUT: 1

0 commit comments

Comments
 (0)