Skip to content

Commit bc9c5aa

Browse files
pascalbergerpascalberger
committed
Merge branch 'release/5.1.0'
2 parents e6064dd + ddcb96e commit bc9c5aa

File tree

533 files changed

+50963
-6548
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

533 files changed

+50963
-6548
lines changed

‎.azuredevops/pipelines/templates/stages/integration-tests-reporting-generic.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ stages:
3131
- powershell: ./build.ps1 --verbosity=diagnostic
3232
workingDirectory: ./tests/Cake.Issues.Reporting.Generic/script-runner
3333
displayName: 'Run integration tests'
34-
- publish: $(Build.SourcesDirectory)/docs/input/docs/report-formats/generic/templates
34+
- publish: $(Build.SourcesDirectory)/docs/input/documentation/report-formats/generic/templates
3535
artifact: Integration Tests Cake.Issues.Reporting.Generic Cake Scripting $(System.JobName)
3636
displayName: 'Publish generated reports as build artifact'
3737
- job: TestReportingGenericFrostingNet8Job
@@ -60,6 +60,6 @@ stages:
6060
- powershell: ./build.ps1 --verbosity=diagnostic
6161
workingDirectory: ./tests/Cake.Issues.Reporting.Generic/frosting
6262
displayName: 'Run integration tests'
63-
- publish: $(Build.SourcesDirectory)/docs/input/docs/report-formats/generic/templates
63+
- publish: $(Build.SourcesDirectory)/docs/input/documentation/report-formats/generic/templates
6464
artifact: Integration Tests Cake.Issues.Reporting.Generic Cake Frosting .NET 8 $(System.JobName)
6565
displayName: 'Publish generated reports as build artifact'

‎.github/actions/prepare-integration-test/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ runs:
1313
name: NuGet Package
1414
path: ./BuildArtifacts/Packages/NuGet
1515
- name: Install .NET
16-
uses: actions/setup-dotnet@3e891b0cb619bf60e2c25674b222b8940e2c1c25 # v4
16+
uses: actions/setup-dotnet@87b7050bc53ea08284295505d98d2aa94301e852 # v4
1717
with:
1818
dotnet-version: ${{ inputs.dotnet-version }}

‎.github/renovate.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
"extends": [
44
"github>cake-contrib/renovate-presets:cake-issues"
55
],
6+
"customManagers": [
7+
{
8+
"customType": "regex",
9+
"description": "Update versions of NuGet packages used in documentation",
10+
"fileMatch": [
11+
"docs/mkdocs.yml$"
12+
],
13+
"matchStrings": [
14+
"\\s*#\\srenovate:\\sdatasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?( extractVersion=(?<extractVersion>.*?))?\\s*.*?_version\\s*:\\s*(?<currentValue>.*)"
15+
]
16+
}
17+
],
618
"packageRules": [
719
{
820
"description": "Ignore Cake runner minor and patch updates",

‎.github/workflows/integrationtests.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@ name: Integration tests
22

33
# Workflow Trigger
44
on:
5-
# Trigger the workflow on a pull request to any branch
5+
# Trigger the workflow on a pull request to any branch, ignoring changes to /docs
66
pull_request:
7-
# Triggers the workflow in the event there is a push to master
7+
paths-ignore:
8+
- 'docs/**'
9+
# Trigger the workflow on pushes to the master branch, ignoring changes to /docs
810
push:
911
branches:
1012
- master
13+
paths-ignore:
14+
- 'docs/**'
1115

1216
jobs:
1317
# Build
@@ -20,7 +24,7 @@ jobs:
2024
- name: Fetch all tags and branches
2125
run: git fetch --prune --unshallow
2226
- name: Install .NET
23-
uses: actions/setup-dotnet@3e891b0cb619bf60e2c25674b222b8940e2c1c25 # v4
27+
uses: actions/setup-dotnet@87b7050bc53ea08284295505d98d2aa94301e852 # v4
2428
with:
2529
# .NET 5 required for GitVersion
2630
dotnet-version: |
@@ -31,7 +35,7 @@ jobs:
3135
run: ./build.sh --target=Create-NuGet-Packages
3236
shell: bash
3337
- name: Publish NuGet package as build artifact
34-
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
38+
uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4
3539
with:
3640
name: NuGet Package
3741
path: ./BuildArtifacts/Packages/NuGet/

‎.github/workflows/publish-develop-docs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Publish Develop Docs
2+
3+
# Workflow Trigger
4+
on:
5+
# Triggers the workflow in the event there is a push to develop
6+
push:
7+
branches:
8+
- develop
9+
10+
permissions:
11+
contents: write
12+
13+
jobs:
14+
deploy:
15+
name: Build & Publish Docs
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Get the sources
19+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
20+
with:
21+
fetch-depth: 0
22+
- name: Install Python
23+
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
24+
with:
25+
python-version: 3.13.1
26+
- name: Install Python Dependencies
27+
run: pip install -r requirements.txt
28+
working-directory: ./docs
29+
- name: Install Required Libraries
30+
run: |
31+
sudo apt-get update
32+
sudo apt-get install -y pngquant
33+
- name: Configure Git
34+
run: |
35+
git config --global user.name "Build Server"
36+
git config --global user.email "ci@cakeissues.net"
37+
- name: Build & Publish
38+
run: mike deploy --push develop
39+
working-directory: ./docs

‎.github/workflows/publish-release-docs.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Publish Release Docs
2+
3+
# Workflow Trigger
4+
on:
5+
# Triggers the workflow in the event there is a release created
6+
release:
7+
types: [published]
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
deploy:
14+
name: Build & Publish Docs
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Get the sources
18+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
19+
with:
20+
fetch-depth: 0
21+
- name: Install Python
22+
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
23+
with:
24+
python-version: 3.13.1
25+
- name: Install Python Dependencies
26+
run: pip install -r requirements.txt
27+
working-directory: ./docs
28+
- name: Install Required Libraries
29+
run: |
30+
sudo apt-get update
31+
sudo apt-get install -y pngquant
32+
- name: Configure Git
33+
run: |
34+
git config --global user.name "Build Server"
35+
git config --global user.email "ci@cakeissues.net"
36+
- name: Build & Publish
37+
run: mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
38+
working-directory: ./docs

‎.github/workflows/pushpreview.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: PushPreview
2+
3+
# Workflow Trigger
4+
on:
5+
# Triggers the workflow if a pull request is labeled with 'preview'
6+
pull_request_target:
7+
types:
8+
- labeled
9+
10+
jobs:
11+
preview:
12+
runs-on: ubuntu-latest
13+
if: github.event.label.name == 'preview'
14+
steps:
15+
- name: Get the sources
16+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
17+
- name: Comment
18+
run: |
19+
gh pr comment ${{ github.event.pull_request.number }} --repo ${{ github.repository }} --body "⚙️ Hang tight! PushPreview is currently building your preview. We'll share the URL as soon as it's ready."
20+
env:
21+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22+
- name: Install Python
23+
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
24+
with:
25+
python-version: 3.13.1
26+
- name: Set BASE_URL
27+
run: echo "BASE_URL=/github/${{ github.repository }}/${{ github.event.number }}/" >> $GITHUB_ENV
28+
- name: Build site
29+
run: |
30+
cd docs
31+
pip install -r requirements.txt
32+
mkdocs build
33+
- name: Generate preview
34+
uses: PushLabsHQ/pushpreview-action@cf958f7be2bf55d3f56d351bb9abf56b4c6b9a50 # 1.0.6
35+
with:
36+
source-directory: ./docs/site
37+
github-token: ${{ secrets.GITHUB_TOKEN }}
38+
pushpreview-token: ${{ secrets.PUSHPREVIEW_TOKEN }}

‎.github/workflows/unittests.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@ name: Unit tests
22

33
# Workflow Trigger
44
on:
5-
# Trigger the workflow on a pull request to any branch
5+
# Trigger the workflow on a pull request to any branch, ignoring changes to /docs
66
pull_request:
7-
# Triggers the workflow in the event there is a push to master
7+
paths-ignore:
8+
- 'docs/**'
9+
# Trigger the workflow on pushes to the master branch, ignoring changes to /docs
810
push:
911
branches:
1012
- master
13+
paths-ignore:
14+
- 'docs/**'
1115

1216
jobs:
1317
Test:
@@ -27,7 +31,7 @@ jobs:
2731
- name: Fetch all tags and branches
2832
run: git fetch --prune --unshallow
2933
- name: Install .NET
30-
uses: actions/setup-dotnet@3e891b0cb619bf60e2c25674b222b8940e2c1c25 # v4
34+
uses: actions/setup-dotnet@87b7050bc53ea08284295505d98d2aa94301e852 # v4
3135
with:
3236
# .NET 5 required for GitVersion
3337
dotnet-version: |

‎.gitignore

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
# Project specific
2-
3-
BuildArtifacts/
4-
51
# Created by https://www.gitignore.io/api/cake,visualstudio
62

73
### Cake ###
@@ -304,4 +300,9 @@ __pycache__/
304300
# By default, sensitive information, such as encrypted password
305301
# should be stored in the .pubxml.user file.
306302

307-
# End of https://www.gitignore.io/api/cake,visualstudio
303+
# End of https://www.gitignore.io/api/cake,visualstudio
304+
305+
# Project specific
306+
307+
BuildArtifacts/
308+
docs/.cache/

‎.vscode/settings.json

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
11
{
2-
"dotnet.defaultSolution": "src\\Cake.Issues.sln"
2+
"dotnet.defaultSolution": "src\\Cake.Issues.sln",
3+
"yaml.schemas": {
4+
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
5+
},
6+
"yaml.customTags": [
7+
"!ENV scalar",
8+
"!ENV sequence",
9+
"!relative scalar",
10+
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
11+
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
12+
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
13+
"tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
14+
]
315
}

‎CONTRIBUTING.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,53 @@ To contribute:
1111
* Push your feature branch.
1212
* Create a pull request.
1313

14-
## Build
14+
## Building
1515

16-
To build this package we are using Cake.
16+
### Prerequisites
17+
18+
General requirements:
19+
20+
* .NET Core 2.1, .NET Core 3.0, .NET Core 3.1, .NET 5 or .NET 6 for running the build
21+
22+
For building addins:
23+
24+
* .NET 9 SKD
25+
26+
For building website:
27+
28+
* Python 3
29+
30+
### Building addins
31+
32+
On Windows PowerShell run:
33+
34+
```powershell
35+
./build.ps1
36+
```
37+
38+
On OSX/Linux run:
39+
40+
```bash
41+
.\build.sh
42+
```
43+
44+
### Start website
1745

1846
On Windows PowerShell run:
1947

2048
```powershell
21-
./build
49+
./build.ps1 --target=website
2250
```
2351

2452
On OSX/Linux run:
2553

2654
```bash
27-
./build.sh
55+
./build.sh --target=website
2856
```
2957

3058
## Release
3159

3260
See [Cake.Recipe documentation] how to create a new release of this addin.
3361

34-
[GitFlow]: (http://nvie.com/posts/a-successful-git-branching-model/)
62+
[GitFlow]: (https://nvie.com/posts/a-successful-git-branching-model/)
3563
[Cake.Recipe documentation]: https://cake-contrib.github.io/Cake.Recipe/docs/usage/creating-release

‎README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -97,15 +97,15 @@ In Cake Frosting they can be added using package references:
9797
<PackageReference Include="Cake.Issues" Version="x.x.x" />
9898
```
9999

100-
See [list of available addins](https://cakeissues.net/addins/).
100+
See [list of available addins](#addins).
101101

102102
### Compatibility
103103

104-
See [Release Notes](https://cakeissues.net/docs/overview/release-notes/Cake.Issues) for requirements for each specific version.
104+
See [Release Notes](https://github.com/cake-contrib/Cake.Issues/releases) for requirements for each specific version.
105105
106106
## Usage
107107

108-
See [Website](https://cakeissues.net/docs/usage/) for detailed usage instructions.
108+
See [Website](https://cakeissues.net/latest/documentation/usage/) for detailed usage instructions.
109109
110110
## Support & Discussion
111111

@@ -123,6 +123,7 @@ For questions and to discuss ideas & feature requests, use the [GitHub discussio
123123
| [Cake.Issues.InspectCode](https://www.nuget.org/packages/Cake.Issues.InspectCode) | [Cake.Frosting.Issues.InspectCode](https://www.nuget.org/packages/Cake.Frosting.Issues.InspectCode) | Issue provider for reading JetBrains Inspect Code issues. |
124124
| [Cake.Issues.Markdownlint](https://www.nuget.org/packages/Cake.Issues.Markdownlint) | [Cake.Frosting.Issues.Markdownlint](https://www.nuget.org/packages/Cake.Frosting.Issues.Markdownlint) | Issue provider for reading issues from markdownlint. |
125125
| [Cake.Issues.Sarif](https://www.nuget.org/packages/Cake.Issues.Sarif) | [Cake.Frosting.Issues.Sarif](https://www.nuget.org/packages/Cake.Frosting.Issues.Sarif) | Issue provider for reading SARIF reports. |
126+
| [Cake.Issues.Tap](https://www.nuget.org/packages/Cake.Issues.Tap) | [Cake.Frosting.Issues.Tap](https://www.nuget.org/packages/Cake.Frosting.Issues.Tap) | Issue provider for reading files in Test Anything Protocol (TAP) format. |
126127
| [Cake.Issues.Terraform](https://www.nuget.org/packages/Cake.Issues.Terraform) | [Cake.Frosting.Issues.Terraform](https://www.nuget.org/packages/Cake.Frosting.Issues.Terraform) | Issue provider for reading Terraform validation output. |
127128
| [Cake.Issues.PullRequests](https://www.nuget.org/packages/Cake.Issues.PullRequests) | [Cake.Frosting.Issues.PullRequests](https://www.nuget.org/packages/Cake.Frosting.Issues.PullRequests) | Addin providing the aliases for writing issues to pull requests and build servers. |
128129
| [Cake.Issues.PullRequests.AppVeyor](https://www.nuget.org/packages/Cake.Issues.PullRequests.AppVeyor) | [Cake.Frosting.Issues.PullRequests.AppVeyor](https://www.nuget.org/packages/Cake.Frosting.Issues.PullRequests.AppVeyor) | Integration with AppVeyor builds. |
@@ -136,7 +137,7 @@ For questions and to discuss ideas & feature requests, use the [GitHub discussio
136137
## API
137138

138139
The Cake Issues addins provide a wide range of additional aliases which can be used in Cake builds.
139-
See [API reference](https://cakeissues.net/dsl/) for an overview.
140+
See [API reference](https://cakeissues.net/latest/api/) for an overview.
140141
141142
## Contributing
142143

@@ -149,9 +150,9 @@ Contributions are welcome. See [Contribution Guidelines](CONTRIBUTING.md).
149150
Binary distributions for some addins contain third-party code which is licensed under its own respective license.
150151
See [LICENSE](LICENSE) for details.
151152

152-
[modular architecture]: https://cakeissues.net/docs/fundamentals/architecture
153-
[extension points]: https://cakeissues.net/docs/extending/
154-
[set of aliases]: https://cakeissues.net/dsl/
155-
[variety of analyzers and linters]: https://cakeissues.net/addins/issue-provider/
156-
[over 15 distinct addins]: https://cakeissues.net/addins/
157-
[75 aliases]: https://cakeissues.net/dsl/
153+
[modular architecture]: https://cakeissues.net/latest/documentation/how-cake-issues-works/
154+
[extension points]: https://cakeissues.net/latest/documentation/extending/
155+
[set of aliases]: https://cakeissues.net/latest/api/
156+
[variety of analyzers and linters]: https://cakeissues.net/latest/documentation/supported-tools/
157+
[over 15 distinct addins]: #addins
158+
[75 aliases]: https://cakeissues.net/latest/api/

0 commit comments

Comments
 (0)