Skip to content

Commit

Permalink
Merge pull request #294 from nils-a/release/1.5.0
Browse files Browse the repository at this point in the history
Release/1.5.0
  • Loading branch information
nils-a authored Nov 20, 2023
2 parents 94a566f + e7a45ce commit 4bc7bbd
Show file tree
Hide file tree
Showing 45 changed files with 1,520 additions and 116 deletions.
21 changes: 20 additions & 1 deletion .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,31 @@
"contributions": [
"doc"
]
},
{
"login": "squid-box",
"name": "Joel Ahlgren",
"avatar_url": "https://avatars.githubusercontent.com/u/864820?v=4",
"profile": "https://www.ahlgren.io",
"contributions": [
"code"
]
},
{
"login": "devlead",
"name": "Mattias Karlsson",
"avatar_url": "https://avatars.githubusercontent.com/u/1647294?v=4",
"profile": "https://www.devlead.se",
"contributions": [
"bug"
]
}
],
"contributorsPerLine": 7,
"projectName": "CakeContrib.Guidelines",
"projectOwner": "cake-contrib",
"repoType": "github",
"repoHost": "https://github.com",
"skipCi": true
"skipCi": true,
"commitConvention": "angular"
}
17 changes: 17 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
codecov:
notify:
require_ci_to_pass: no

coverage:
precision: 2
round: down
range: "75...100"
status:
project:
default:
target: 80%
threshold: 3%
patch:
default:
target: 80%
threshold: 3%
12 changes: 7 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ ubuntu-18.04, windows-2019, macos-10.15 ]
os: [ ubuntu-22.04, windows-2022, macos-12 ]

env:
AZURE_PASSWORD: ${{ secrets.AZURE_PASSWORD }}
Expand All @@ -44,20 +44,22 @@ jobs:

steps:
- name: Checkout the repository
uses: actions/checkout@v3
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
- name: Fetch all tags and branches
run: git fetch --prune --unshallow
- uses: actions/setup-dotnet@v3.0.3
- uses: actions/setup-dotnet@v3.2.0
with:
# codecov needs 2.1
# unittests needs 3.1
# gitversion needs 5.0
# .NET 6 to build
# .NET 6/7 to build
dotnet-version: |
2.1
3.1
5.0
6.0
7.0
8.0
- name: Cache Tools
uses: actions/cache@v3
with:
Expand All @@ -84,4 +86,4 @@ jobs:
with:
if-no-files-found: warn
name: package
path: BuildArtifacts/Packages/**/*
path: BuildArtifacts/Packages/**/*
14 changes: 10 additions & 4 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ on:
jobs:
analyze:
name: Analyze
runs-on: ubuntu-18.04
runs-on: ubuntu-22.04

strategy:
fail-fast: false
Expand All @@ -30,10 +30,16 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
with:
fetch-depth: 0

- uses: actions/[email protected]
with:
dotnet-version: |
5.0
8.0
- name: Cache Tools
uses: actions/cache@v3
with:
Expand All @@ -46,7 +52,7 @@ jobs:
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

Expand All @@ -58,4 +64,4 @@ jobs:
cake-version: 1.3.0

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
uses: github/codeql-action/analyze@v2
2 changes: 1 addition & 1 deletion .github/workflows/publishDocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:

steps:
- name: checkout
uses: actions/checkout@v3
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4

- name: Fetch all tags and branches
run: git fetch --prune --unshallow
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/updateToc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
with:
fetch-depth: 0
ref: ${{ github.event.ref }}
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{
"powershell.codeFormatting.addWhitespaceAroundPipe": true
"powershell.codeFormatting.addWhitespaceAroundPipe": true,
"markdown.extension.toc.updateOnSave": false
}
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![standard-readme compliant][]][standard-readme]
[![All Contributors][all-contributors-badge]](#contributors)
[![Contributor Covenant][contrib-covenantimg]][contrib-covenant]
[![Appveyor build][appveyorimage]][appveyor]
[![Build][build-badge]][build]
[![NuGet package][nugetimage]][nuget]

Adds common guidelines to cake-contrib projects
Expand Down Expand Up @@ -74,13 +74,17 @@ Thanks goes to these wonderful people ([emoji key][emoji-key]):
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/AdmiringWorm"><img src="https://avatars.githubusercontent.com/u/1474648?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kim J. Nordmo</b></sub></a><br /><a href="#question-AdmiringWorm" title="Answering Questions">💬</a> <a href="#ideas-AdmiringWorm" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/Jericho"><img src="https://avatars.githubusercontent.com/u/112710?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jericho</b></sub></a><br /><a href="https://github.com/cake-contrib/CakeContrib.Guidelines/issues?q=author%3AJericho" title="Bug reports">🐛</a> <a href="#ideas-Jericho" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/nils-a"><img src="https://avatars.githubusercontent.com/u/349188?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nils Andresen</b></sub></a><br /><a href="https://github.com/cake-contrib/CakeContrib.Guidelines/commits?author=nils-a" title="Code">💻</a> <a href="#maintenance-nils-a" title="Maintenance">🚧</a></td>
<td align="center"><a href="https://augustoproiete.net"><img src="https://avatars.githubusercontent.com/u/177608?v=4?s=100" width="100px;" alt=""/><br /><sub><b>C. Augusto Proiete</b></sub></a><br /><a href="#ideas-augustoproiete" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/cake-contrib/CakeContrib.Guidelines/pulls?q=is%3Apr+reviewed-by%3Aaugustoproiete" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/DiDoHH"><img src="https://avatars.githubusercontent.com/u/45682415?v=4?s=100" width="100px;" alt=""/><br /><sub><b>DiDoHH</b></sub></a><br /><a href="https://github.com/cake-contrib/CakeContrib.Guidelines/commits?author=DiDoHH" title="Documentation">📖</a></td>
</tr>
<tbody>
<tr>
<td align="center"><a href="https://github.com/AdmiringWorm"><img src="https://avatars.githubusercontent.com/u/1474648?v=4?s=100" width="100px;" alt="Kim J. Nordmo"/><br /><sub><b>Kim J. Nordmo</b></sub></a><br /><a href="#question-AdmiringWorm" title="Answering Questions">💬</a> <a href="#ideas-AdmiringWorm" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/Jericho"><img src="https://avatars.githubusercontent.com/u/112710?v=4?s=100" width="100px;" alt="Jericho"/><br /><sub><b>Jericho</b></sub></a><br /><a href="https://github.com/cake-contrib/CakeContrib.Guidelines/issues?q=author%3AJericho" title="Bug reports">🐛</a> <a href="#ideas-Jericho" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/nils-a"><img src="https://avatars.githubusercontent.com/u/349188?v=4?s=100" width="100px;" alt="Nils Andresen"/><br /><sub><b>Nils Andresen</b></sub></a><br /><a href="https://github.com/cake-contrib/CakeContrib.Guidelines/commits?author=nils-a" title="Code">💻</a> <a href="#maintenance-nils-a" title="Maintenance">🚧</a></td>
<td align="center"><a href="https://augustoproiete.net"><img src="https://avatars.githubusercontent.com/u/177608?v=4?s=100" width="100px;" alt="C. Augusto Proiete"/><br /><sub><b>C. Augusto Proiete</b></sub></a><br /><a href="#ideas-augustoproiete" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/cake-contrib/CakeContrib.Guidelines/pulls?q=is%3Apr+reviewed-by%3Aaugustoproiete" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/DiDoHH"><img src="https://avatars.githubusercontent.com/u/45682415?v=4?s=100" width="100px;" alt="DiDoHH"/><br /><sub><b>DiDoHH</b></sub></a><br /><a href="https://github.com/cake-contrib/CakeContrib.Guidelines/commits?author=DiDoHH" title="Documentation">📖</a></td>
<td align="center"><a href="https://www.ahlgren.io"><img src="https://avatars.githubusercontent.com/u/864820?v=4?s=100" width="100px;" alt="Joel Ahlgren"/><br /><sub><b>Joel Ahlgren</b></sub></a><br /><a href="https://github.com/cake-contrib/CakeContrib.Guidelines/commits?author=squid-box" title="Code">💻</a></td>
<td align="center"><a href="https://www.devlead.se"><img src="https://avatars.githubusercontent.com/u/1647294?v=4?s=100" width="100px;" alt="Mattias Karlsson"/><br /><sub><b>Mattias Karlsson</b></sub></a><br /><a href="https://github.com/cake-contrib/CakeContrib.Guidelines/issues?q=author%3Adevlead" title="Bug reports">🐛</a></td>
</tr>
</tbody>
</table>

<!-- markdownlint-restore -->
Expand All @@ -94,8 +98,8 @@ Thanks goes to these wonderful people ([emoji key][emoji-key]):

[all-contributors]: https://github.com/all-contributors/all-contributors
[all-contributors-badge]: https://img.shields.io/github/all-contributors/cake-contrib/CakeContrib.Guidelines/develop?&style=flat-square
[appveyor]: https://ci.appveyor.com/project/cakecontrib/cakecontrib-guidelines
[appveyorimage]: https://img.shields.io/appveyor/ci/cakecontrib/cakecontrib-guidelines.svg?logo=appveyor&style=flat-square
[build]: https://github.com/cake-contrib/CakeContrib.Guidelines/actions/workflows/build.yml
[build-badge]: https://github.com/cake-contrib/CakeContrib.Guidelines/actions/workflows/build.yml/badge.svg
[contrib-covenant]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/
[contrib-covenantimg]: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
[contributing]: CONTRIBUTING.md
Expand Down
129 changes: 129 additions & 0 deletions docs/input/guidelines/CakeInternalReferences.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
---
Title: Target Frameworks
---

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents

- [Goals](#goals)
- [Provided packages](#provided-packages)
- [Cake v1.0](#cake-v10)
- [Cake v2.0.0](#cake-v200)
- [Cake v3.0.0](#cake-v300)
- [Related rules](#related-rules)
- [Usage](#usage)
- [Settings](#settings)
- [Cake Version](#cake-version)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Goals

When an addin/module references a package that is also provided by Cake at runtime,
the version the addin/module references should match the version provided by Cake.
Also, the reference of the package in the addin/module should be set as private assets.

### Provided packages

#### Cake v1.0

| Reference | Version |
| ---------------------------------------- | ------------- |
| Autofac | 6.1.0 |
| Microsoft.CodeAnalysis.CSharp.Scripting | 3.9.0-1.final |
| Microsoft.CSharp | 4.7.0 |
| Microsoft.DotNet.PlatformAbstractions | 3.1.6 |
| Microsoft.Extensions.DependencyInjection | 5.0.1 |
| Microsoft.NETCore.Platforms | 5.0.0 |
| Microsoft.Win32.Registry | 5.0.0 |
| Newtonsoft.Json | 12.0.3 |
| NuGet.Common | 5.8.0 |
| NuGet.Frameworks | 5.8.0 |
| NuGet.Packaging | 5.8.0 |
| NuGet.Protocol | 5.8.0 |
| NuGet.Resolver | 5.8.0 |
| NuGet.Versioning | 5.8.0 |
| System.Collections.Immutable | 5.0.0 |
| System.Reflection.Metadata | 5.0.0 |
| xunit | 2.4.1 |

#### Cake v2.0.0

| Reference | Version |
| ---------------------------------------- | ------- |
| Autofac | 6.3.0 |
| Microsoft.CodeAnalysis.CSharp.Scripting | 4.0.1 |
| Microsoft.CSharp | 4.7.0 |
| Microsoft.DotNet.PlatformAbstractions | 3.1.6 |
| Microsoft.Extensions.DependencyInjection | 6.0.0 |
| Microsoft.NETCore.Platforms | 6.0.0 |
| Microsoft.Win32.Registry | 5.0.0 |
| Newtonsoft.Json | 13.0.1 |
| NuGet.Common | 5.11.0 |
| NuGet.Frameworks | 5.11.0 |
| NuGet.Packaging | 5.11.0 |
| NuGet.Protocol | 5.11.0 |
| NuGet.Resolver | 5.11.0 |
| NuGet.Versioning | 5.11.0 |
| System.Collections.Immutable | 6.0.0 |
| System.Reflection.Metadata | 6.0.0 |
| xunit | 2.4.1 |

#### Cake v3.0.0

| Reference | Version |
| ---------------------------------------- | ------------- |
| Autofac | 6.4.0 |
| Microsoft.CodeAnalysis.CSharp.Scripting | 4.4.0-4.final |
| Microsoft.CSharp | 4.7.0 |
| Microsoft.Extensions.DependencyInjection | 7.0.0 |
| Microsoft.NETCore.Platforms | 7.0.0 |
| Microsoft.Win32.Registry | 5.0.0 |
| Newtonsoft.Json | 13.0.1 |
| NuGet.Common | 6.3.1 |
| NuGet.Frameworks | 6.3.1 |
| NuGet.Packaging | 6.3.1 |
| NuGet.Protocol | 6.3.1 |
| NuGet.Resolver | 6.3.1 |
| NuGet.Versioning | 6.3.1 |
| System.Collections.Immutable | 7.0.0 |
| System.Reflection.Metadata | 7.0.0 |
| xunit | 2.4.2 |

#### Cake v4.0

| Reference | Version |
| ---------------------------------------- | ------------- |
| Autofac | 7.1.0 |
| Microsoft.CodeAnalysis.CSharp.Scripting | 4.8.0-3.final |
| Microsoft.CSharp | 4.7.0 |
| Microsoft.Extensions.DependencyInjection | 8.0.0 |
| Microsoft.NETCore.Platforms | 7.0.4 |
| Microsoft.Win32.Registry | 5.0.0 |
| Newtonsoft.Json | 13.0.3 |
| NuGet.Common | 6.7.0 |
| NuGet.Frameworks | 6.7.0 |
| NuGet.Packaging | 6.7.0 |
| NuGet.Protocol | 6.7.0 |
| NuGet.Resolver | 6.7.0 |
| NuGet.Versioning | 6.7.0 |
| System.Collections.Immutable | 8.0.0 |
| System.Reflection.Metadata | 8.0.0 |
| xunit | 2.6.1 |

## Related rules

* [CCG0010](../rules/ccg0010)

These rules are only applied for [project types](../settings#projecttype) `addin` and `module`.

## Usage

Using this package automatically enables this guideline.

## Settings

### Cake Version

<?! Include "../settings/fragments/OverrideCakeVersion.md" /?>
19 changes: 17 additions & 2 deletions docs/input/guidelines/TargetFramework.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ Title: Target Frameworks
- [Related rules](#related-rules)
- [Usage](#usage)
- [Settings](#settings)
- [Cake Version](#cake-version)
- [Opt-Out](#opt-out)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Goals

Each addin/module should have maximum compatibility when being used. Toward that end some Framework versions are required and some others are
suggested, depending on the Cake.Core version that is being referenced.
Each addin/module should have maximum compatibility when being used. Toward that end some Framework versions are required and some others are
suggested, depending on the Cake.Core version that is being referenced.

### Required / Suggested versions

Expand All @@ -43,13 +44,23 @@ while missing a suggested target version will raise [CCG0007](../rules/ccg0007)
* Cake.Core >= 3.0.0
* Required: `net6.0`
* Required: `net7.0`
* Cake.Core >= 4.0.0
* Required: `net6.0`
* Required: `net7.0`
* Required: `net8.0`
* Package type: module
* Cake.Core < 2.0.0
* Required: `netstandard2.0`
* No additional targets are allowed.
* Cake.Core >= 2.0.0
* Required: `netcoreapp3.1`
* No additional targets are allowed.
* Cake.Core >= 3.0.0
* Required: `net6.0`
* No additional targets are allowed.
* Cake.Core >= 4.0.0
* Required: `net6.0`
* No additional targets are allowed.

For package type recipe no framework reference is required or suggested.

Expand All @@ -65,6 +76,10 @@ Using this package automatically enables this guideline.

## Settings

### Cake Version

<?! Include "../settings/fragments/OverrideCakeVersion.md" /?>

### Opt-Out

<?! Include "../settings/fragments/OmitTargetFramework.md" /?>
Loading

0 comments on commit 4bc7bbd

Please sign in to comment.