Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(GH-125) Remove Cake and Documentation #126

Merged
merged 8 commits into from
Jan 4, 2023
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
34 changes: 0 additions & 34 deletions .appveyor.yml

This file was deleted.

8 changes: 8 additions & 0 deletions .github/codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
coverage:
status:
project:
default:
informational: true
patch:
default:
informational: true
55 changes: 55 additions & 0 deletions .github/workflows/dotnet.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# This workflow will build BBT.Maybe project

name: CI

on:
push:
branches:
- master
- develop
pull_request:
branches:
- master
- develop

defaults:
run:
working-directory: src

jobs:
build:
env:
BUILD_CONFIG: "Debug"

runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]

steps:
- uses: actions/checkout@v3

- name: Get Build Version
run: |
Import-Module ..\build\GetBuildVersion.psm1
Write-Host $Env:GITHUB_REF
$version = GetBuildVersion -VersionString $Env:GITHUB_REF
echo "BUILD_VERSION=$version" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
shell: pwsh

- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 6.0.x

- name: Restore dependencies
run: dotnet restore

- name: Build
run: dotnet build --configuration $BUILD_CONFIG -p:Version=$BUILD_VERSION --no-restore

- name: Test
run: dotnet test -p:Configuration=$BUILD_CONFIG --no-restore --no-build --verbosity normal --collect:"XPlat Code Coverage" --results-directory ./coverage

- name: Codecov
uses: codecov/codecov-action@v3
58 changes: 58 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# This workflow will release BBT.Maybe

name: Release

on:
release:
types: [published]

defaults:
run:
working-directory: src

jobs:
build:
env:
BUILD_CONFIG: "Release"

runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest]

steps:
- uses: actions/checkout@v3

- name: Get Build Version
run: |
Import-Module ..\build\GetBuildVersion.psm1
Write-Host $Env:GITHUB_REF
$version = GetBuildVersion -VersionString $Env:GITHUB_REF
echo "BUILD_VERSION=$version" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
shell: pwsh

- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 6.0.x

- name: Restore dependencies
run: dotnet restore

- name: Build
run: dotnet build --configuration $BUILD_CONFIG -p:Version=$BUILD_VERSION --no-restore

- name: Test
run: dotnet test -p:Configuration=$BUILD_CONFIG --no-restore --no-build --verbosity normal --collect:"XPlat Code Coverage"

- name: Codecov
uses: codecov/codecov-action@v1.5.2

- name: Setup NuGet
uses: NuGet/setup-nuget@v1

- name: Package NuGet
run: nuget pack **\*.nuspec

- name: Publish NuGet
run: nuget push **\*.nupkg -Source 'https://api.nuget.org/v3/index.json' -ApiKey ${{secrets.NUGETORG}}
7 changes: 0 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -298,10 +298,6 @@ paket-files/
__pycache__/
*.pyc

# Cake - Uncomment if you are using it
tools/**
!tools/packages.config

# Tabs Studio
*.tss

Expand Down Expand Up @@ -330,6 +326,3 @@ ASALocalRun/
.mfractor/

# Project specific

config.wyam.*
BuildArtifacts/
21 changes: 21 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"version": "0.2.0",
"configurations": [
{
"name": ".NET Core Launch (console)",
"type": "coreclr",
"request": "launch",
"preLaunchTask": "build",
"program": "${workspaceFolder}/bin/Debug/netstandard2.0/BBT.Maybe.dll",
"args": [],
"cwd": "${workspaceFolder}",
"console": "internalConsole",
"stopAtEntry": false
},
{
"name": ".NET Core Attach",
"type": "coreclr",
"request": "attach"
}
]
}
41 changes: 41 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "build",
"command": "dotnet",
"type": "process",
"args": [
"build",
"${workspaceFolder}/src/BBT.Maybe.sln",
"/property:GenerateFullPaths=true",
"/consoleloggerparameters:NoSummary"
],
"problemMatcher": "$msCompile"
},
{
"label": "publish",
"command": "dotnet",
"type": "process",
"args": [
"publish",
"${workspaceFolder}/src/BBT.Maybe.sln",
"/property:GenerateFullPaths=true",
"/consoleloggerparameters:NoSummary"
],
"problemMatcher": "$msCompile"
},
{
"label": "watch",
"command": "dotnet",
"type": "process",
"args": [
"watch",
"run",
"--project",
"${workspaceFolder}/src/BBT.Maybe.sln"
],
"problemMatcher": "$msCompile"
}
]
}
12 changes: 0 additions & 12 deletions GitReleaseManager.yaml

This file was deleted.

38 changes: 16 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,30 @@
# BBT.Maybe

An option type for .NET.
[![NuGet](https://img.shields.io/nuget/v/BBT.Maybe.svg)](https://www.nuget.org/packages/BBT.Maybe)
[![Build status](https://github.com/bbtsoftware/BBT.Maybe/actions/workflows/dotnet.yml/badge.svg?branch=develop)](https://github.com/bbtsoftware/TfsUrlParser/actions/workflows/dotnet.yml)
[![Build status](https://github.com/bbtsoftware/BBT.Maybe/actions/workflows/release.yml/badge.svg)](https://github.com/bbtsoftware/BBT.Maybe/actions/workflows/release.yml)
[![Coverage Status](https://codecov.io/gh/bbtsoftware/BBT.Maybe/branch/develop/graph/badge.svg?token=0VLbB8a8EF)](https://codecov.io/gh/bbtsoftware/BBT.Maybe)

[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/bbtsoftware/BBT.Maybe/blob/master/LICENSE)
An option type implementation for .NET.

## Information
[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/bbtsoftware/BBT.Maybe/blob/master/LICENSE)

| | Stable | Pre-release |
|:--:|:--:|:--:|
|GitHub Release|-|[![GitHub release](https://img.shields.io/github/release/bbtsoftware/BBT.Maybe.svg)](https://github.com/bbtsoftware/BBT.Maybe/releases/latest)|
|NuGet|[![NuGet](https://img.shields.io/nuget/v/BBT.Maybe.svg)](https://www.nuget.org/packages/BBT.Maybe)|[![NuGet](https://img.shields.io/nuget/vpre/BBT.Maybe.svg)](https://www.nuget.org/packages/BBT.Maybe)|
## Documentation

## Build Status
### Getting started

|Develop|Master|
|:--:|:--:|
|[![Build status](https://ci.appveyor.com/api/projects/status/vo6s6rr35xq9pk7h/branch/develop?svg=true)](https://ci.appveyor.com/project/BBTSoftwareAG/bbt-maybe/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/vo6s6rr35xq9pk7h/branch/master?svg=true)](https://ci.appveyor.com/project/BBTSoftwareAG/bbt-maybe/branch/master)|
Overview about the features of BBT.Maybe.

## Code Coverage
* [Why does BBT.Maybe exist?](./docs/getting-started/whymaybe.md)
* [Core principles](./docs/getting-started/principles.md)

[![Coverage Status](https://coveralls.io/repos/github/bbtsoftware/BBT.Maybe/badge.svg?branch=develop)](https://coveralls.io/github/bbtsoftware/BBT.Maybe?branch=develop)
### Usage

## Quick Links
How to obtain, configure, and use BBT.Maybe.

* [Documentation](https://bbtsoftware.github.io/BBT.Maybe/)
* [Obtain](./docs/usage/obtain.md)
* [Examples](./docs/usage/examples.md)

## Build

To build this package we are using Cake.

On Windows PowerShell run:

```powershell
./build
```
`dotnet build .\src\BBT.Maybe.sln`
Loading