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

Compatibility with the nightly branch #94

Merged
merged 17 commits into from
Oct 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: bug_report
description: File a bug report
title: "Bug: "
labels: ["bug", "triage"]
assignees:
- octocat
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what
attributes:
label: Describe the bug
description: What exactly is going wrong?
placeholder: A short description of what the bug is.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: What are the steps necessary to reproduce this bug?
placeholder: Detail the steps taken to reproduce the behaviour.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behaviour
description: What is the behaviour that you would expect to see?
placeholder: A clear and concise description of what you expected to happen.
validations:
required: true
- type: input
id: driver_version
attributes:
label: Surreal.NET driver version
description: The version of the NuGet package
placeholder: 1.0.8
validations:
required: true
- type: input
id: db_version
attributes:
label: SurrealDB version
description: Copy and paste the output of `surreal version`
placeholder: surreal 0.0.0 for macOS on aarch64
validations:
required: true
- type: checkboxes
id: check
attributes:
label: Is there an existing issue for this?
description: Please search [our issues](https://github.com/Surreal-Net/Surreal.Net/issues) to see if this bug already exists.
options:
- label: I have searched the existing issues
required: true
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question or idea
url: https://github.com/Surreal-Net/Surreal.Net/discussions
about: Ask questions and discuss ideas here.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Documentation
description: Report an issue related to documentation
title: "Documentation: "
labels: ["documentation", "triage"]
assignees:
- octocat
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to make our documentation better!
- type: textarea
id: description
attributes:
label: Description
description: What should be changed in the docs?
placeholder: A clear and concise description of how the documentation should be updated.
validations:
required: true
- type: checkboxes
id: check
attributes:
label: Is there an existing issue for this?
description: Please search [our issues](https://github.com/Surreal-Net/Surreal.Net/issues) to see if this bug already exists.
options:
- label: I have searched the existing issues
required: true
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: feature_request
description: File a feature request
title: "Feature: "
labels: ["feature", "triage"]
assignees:
- octocat
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to suggest an idea for SurrealDB!
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: What is the usecase in which this feature is relevant?
placeholder: A clear and concise description of what the problem is.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Describe the solution
description: Describe the solution and how it might work.
placeholder: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternative methods
description: Describe alternatives you've considered.
placeholder: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: input
id: driver_version
attributes:
label: Surreal.NET driver version
description: The version of the NuGet package
placeholder: 1.0.8
validations:
required: true
- type: input
id: db_version
attributes:
label: SurrealDB version
description: Copy and paste the output of `surreal version`
placeholder: surreal 0.0.0 for macOS on aarch64
validations:
required: true
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: [email protected]
validations:
required: false
- type: checkboxes
id: check
attributes:
label: Is there an existing issue for this?
description: Please search [our issues](https://github.com/Surreal-Net/Surreal.Net/issues) to see if this bug already exists.
options:
- label: I have searched the existing issues
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Thanks a lot for the PR! We appreciate you spending the time to work on these changes.

## Title

Prefix the type of change in the title for a concise description

- NEW: Add something entirely new. E.g. NEW: Add Git ignore file
- IMPROVE: Improve/enhance piece of code like refactoring etc. E.g. IMPROVE: Remote IP API Function
- FIX: Fix a bug — need I say more? E.g. 🐛 FIX: Case conversion
- DOC: Add documentation like README.md, or even inline docs. E.g. DOC: API Interface Tutorial
- TEST: Related to testing. E.g. 🤖 TEST: Mock User Login/Logout

---

## Motivation

Provide information on the motivation for why you have made this change.

## Description

Provide a description of what this pull request does.


## Breaking changes

Provide a description of how changes to existing behavior require manual intervention for users. E.g. a method signature changed.

## Testing

For functional changes (basically everything except documentation), describe how the effect of the PR is tested.
For new functionality consider adding unit tests.

## Issues

Is the PR related to an existing issue? Link related issues here.

-
96 changes: 96 additions & 0 deletions .github/workflows/build-nightly.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Build & Test

on:
workflow_dispatch:
push:
branches:
- "develop"
- "feature/**"
paths-ignore:
- ".github/**"
- "docs/**"
- "examples/**"
- "*.md"
- "*.yml"
env:
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
DOTNET_CLI_TELEMETRY_OPTOUT: 1
DOTNET_SYSTEM_GLOBALIZATION_INVARIANT: true
defaults:
run:
shell: bash

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
dotnet:
[{ ch: "3.1", ver: "netcoreapp31" }, { ch: "6.0", ver: "net60" }]
channel: ["nightly"]
fail-fast: false

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Initialize Cache
uses: actions/cache@v3
with:
path: ~/.nuget/packages
# Look to see if there is a cache hit for the corresponding requirements file
key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
restore-keys: |
${{ runner.os }}-nuget

- name: Initialize SurrealDB
run: |
mkdir -p ~/.local/bin || exit 1
mkdir -p ~/tmp || exit 1
pushd ~/tmp || exit 1

curl -sSf https://install.surrealdb.com -o ./surealdb-install.sh
chmod +x ./surealdb-install.sh
./surealdb-install.sh ~/.local/bin --${{ matrix.channel }}
export PATH="$HOME/.local/bin/:$PATH"

popd

surreal version || exit 1

- name: Initialize .NET SDK
run: |
curl https://dot.net/v1/dotnet-install.sh -o ~/dotnet-install.sh
chmod +x ~/dotnet-install.sh
~/dotnet-install.sh -c ${{ matrix.dotnet.ch }}
dotnet --info

- name: Restore Dependencies
run: dotnet restore

- name: Build Solution
run: dotnet build --no-restore -f:${{ matrix.dotnet.ver }}

- name: Execute Unit-Tests
run: |
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

- name: Test Report
if: success() || failure()
uses: phoenix-actions/test-reporting@v8
with:
name: results-${{ matrix.dotnet.ver }}-${{ matrix.channel }}
path: test-results.trx
reporter: dotnet-trx
fail-on-error: false

- name: Test Coverage
if: ${{ github.ref == 'refs/heads/master' }}
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./coverage.cobertura.xml
flags: unittests
name: Surreal.Net
fail_ci_if_error: false
verbose: true
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@ name: Build & Test
on:
workflow_dispatch:
push:
branches:
- "master"
- "hotfix/**"
paths-ignore:
- ".github/**"
- "docs/**"
- "examples/**"
- "*.md"
- "*.yml"
env:
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
DOTNET_CLI_TELEMETRY_OPTOUT: 1
Expand All @@ -18,7 +27,7 @@ jobs:
matrix:
dotnet:
[{ ch: "3.1", ver: "netcoreapp31" }, { ch: "6.0", ver: "net60" }]
channel: ["nightly", "stable"]
channel: ["stable"]
fail-fast: false

steps:
Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ name: Documentation

on:
push:
branches: [master]
branches:
- "master"
- "doc/**"
paths-ignore:
- ".github/"
- "tests/"
- ".github/**"
- "tests/**"
env:
DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
DOTNET_CLI_TELEMETRY_OPTOUT: 1
Expand Down
Loading