Skip to content

Commit

Permalink
Merge branch 'release/5.1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalberger committed Jan 3, 2025
2 parents e6064dd + ddcb96e commit bc9c5aa
Show file tree
Hide file tree
Showing 533 changed files with 50,963 additions and 6,548 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ stages:
- powershell: ./build.ps1 --verbosity=diagnostic
workingDirectory: ./tests/Cake.Issues.Reporting.Generic/script-runner
displayName: 'Run integration tests'
- publish: $(Build.SourcesDirectory)/docs/input/docs/report-formats/generic/templates
- publish: $(Build.SourcesDirectory)/docs/input/documentation/report-formats/generic/templates
artifact: Integration Tests Cake.Issues.Reporting.Generic Cake Scripting $(System.JobName)
displayName: 'Publish generated reports as build artifact'
- job: TestReportingGenericFrostingNet8Job
Expand Down Expand Up @@ -60,6 +60,6 @@ stages:
- powershell: ./build.ps1 --verbosity=diagnostic
workingDirectory: ./tests/Cake.Issues.Reporting.Generic/frosting
displayName: 'Run integration tests'
- publish: $(Build.SourcesDirectory)/docs/input/docs/report-formats/generic/templates
- publish: $(Build.SourcesDirectory)/docs/input/documentation/report-formats/generic/templates
artifact: Integration Tests Cake.Issues.Reporting.Generic Cake Frosting .NET 8 $(System.JobName)
displayName: 'Publish generated reports as build artifact'
2 changes: 1 addition & 1 deletion .github/actions/prepare-integration-test/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ runs:
name: NuGet Package
path: ./BuildArtifacts/Packages/NuGet
- name: Install .NET
uses: actions/setup-dotnet@3e891b0cb619bf60e2c25674b222b8940e2c1c25 # v4
uses: actions/setup-dotnet@87b7050bc53ea08284295505d98d2aa94301e852 # v4
with:
dotnet-version: ${{ inputs.dotnet-version }}
12 changes: 12 additions & 0 deletions .github/renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
"extends": [
"github>cake-contrib/renovate-presets:cake-issues"
],
"customManagers": [
{
"customType": "regex",
"description": "Update versions of NuGet packages used in documentation",
"fileMatch": [
"docs/mkdocs.yml$"
],
"matchStrings": [
"\\s*#\\srenovate:\\sdatasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?( extractVersion=(?<extractVersion>.*?))?\\s*.*?_version\\s*:\\s*(?<currentValue>.*)"
]
}
],
"packageRules": [
{
"description": "Ignore Cake runner minor and patch updates",
Expand Down
12 changes: 8 additions & 4 deletions .github/workflows/integrationtests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@ name: Integration tests

# Workflow Trigger
on:
# Trigger the workflow on a pull request to any branch
# Trigger the workflow on a pull request to any branch, ignoring changes to /docs
pull_request:
# Triggers the workflow in the event there is a push to master
paths-ignore:
- 'docs/**'
# Trigger the workflow on pushes to the master branch, ignoring changes to /docs
push:
branches:
- master
paths-ignore:
- 'docs/**'

jobs:
# Build
Expand All @@ -20,7 +24,7 @@ jobs:
- name: Fetch all tags and branches
run: git fetch --prune --unshallow
- name: Install .NET
uses: actions/setup-dotnet@3e891b0cb619bf60e2c25674b222b8940e2c1c25 # v4
uses: actions/setup-dotnet@87b7050bc53ea08284295505d98d2aa94301e852 # v4
with:
# .NET 5 required for GitVersion
dotnet-version: |
Expand All @@ -31,7 +35,7 @@ jobs:
run: ./build.sh --target=Create-NuGet-Packages
shell: bash
- name: Publish NuGet package as build artifact
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4
with:
name: NuGet Package
path: ./BuildArtifacts/Packages/NuGet/
Expand Down
39 changes: 39 additions & 0 deletions .github/workflows/publish-develop-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Publish Develop Docs

# Workflow Trigger
on:
# Triggers the workflow in the event there is a push to develop
push:
branches:
- develop

permissions:
contents: write

jobs:
deploy:
name: Build & Publish Docs
runs-on: ubuntu-latest
steps:
- name: Get the sources
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
fetch-depth: 0
- name: Install Python
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
with:
python-version: 3.13.1
- name: Install Python Dependencies
run: pip install -r requirements.txt
working-directory: ./docs
- name: Install Required Libraries
run: |
sudo apt-get update
sudo apt-get install -y pngquant
- name: Configure Git
run: |
git config --global user.name "Build Server"
git config --global user.email "[email protected]"
- name: Build & Publish
run: mike deploy --push develop
working-directory: ./docs
38 changes: 38 additions & 0 deletions .github/workflows/publish-release-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Publish Release Docs

# Workflow Trigger
on:
# Triggers the workflow in the event there is a release created
release:
types: [published]

permissions:
contents: write

jobs:
deploy:
name: Build & Publish Docs
runs-on: ubuntu-latest
steps:
- name: Get the sources
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
fetch-depth: 0
- name: Install Python
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
with:
python-version: 3.13.1
- name: Install Python Dependencies
run: pip install -r requirements.txt
working-directory: ./docs
- name: Install Required Libraries
run: |
sudo apt-get update
sudo apt-get install -y pngquant
- name: Configure Git
run: |
git config --global user.name "Build Server"
git config --global user.email "[email protected]"
- name: Build & Publish
run: mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
working-directory: ./docs
38 changes: 38 additions & 0 deletions .github/workflows/pushpreview.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: PushPreview

# Workflow Trigger
on:
# Triggers the workflow if a pull request is labeled with 'preview'
pull_request_target:
types:
- labeled

jobs:
preview:
runs-on: ubuntu-latest
if: github.event.label.name == 'preview'
steps:
- name: Get the sources
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- name: Comment
run: |
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."
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Install Python
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
with:
python-version: 3.13.1
- name: Set BASE_URL
run: echo "BASE_URL=/github/${{ github.repository }}/${{ github.event.number }}/" >> $GITHUB_ENV
- name: Build site
run: |
cd docs
pip install -r requirements.txt
mkdocs build
- name: Generate preview
uses: PushLabsHQ/pushpreview-action@cf958f7be2bf55d3f56d351bb9abf56b4c6b9a50 # 1.0.6
with:
source-directory: ./docs/site
github-token: ${{ secrets.GITHUB_TOKEN }}
pushpreview-token: ${{ secrets.PUSHPREVIEW_TOKEN }}
10 changes: 7 additions & 3 deletions .github/workflows/unittests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,16 @@ name: Unit tests

# Workflow Trigger
on:
# Trigger the workflow on a pull request to any branch
# Trigger the workflow on a pull request to any branch, ignoring changes to /docs
pull_request:
# Triggers the workflow in the event there is a push to master
paths-ignore:
- 'docs/**'
# Trigger the workflow on pushes to the master branch, ignoring changes to /docs
push:
branches:
- master
paths-ignore:
- 'docs/**'

jobs:
Test:
Expand All @@ -27,7 +31,7 @@ jobs:
- name: Fetch all tags and branches
run: git fetch --prune --unshallow
- name: Install .NET
uses: actions/setup-dotnet@3e891b0cb619bf60e2c25674b222b8940e2c1c25 # v4
uses: actions/setup-dotnet@87b7050bc53ea08284295505d98d2aa94301e852 # v4
with:
# .NET 5 required for GitVersion
dotnet-version: |
Expand Down
11 changes: 6 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Project specific

BuildArtifacts/

# Created by https://www.gitignore.io/api/cake,visualstudio

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

# End of https://www.gitignore.io/api/cake,visualstudio
# End of https://www.gitignore.io/api/cake,visualstudio

# Project specific

BuildArtifacts/
docs/.cache/
14 changes: 13 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
{
"dotnet.defaultSolution": "src\\Cake.Issues.sln"
"dotnet.defaultSolution": "src\\Cake.Issues.sln",
"yaml.schemas": {
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
},
"yaml.customTags": [
"!ENV scalar",
"!ENV sequence",
"!relative scalar",
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
"tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
]
}
38 changes: 33 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,53 @@ To contribute:
* Push your feature branch.
* Create a pull request.

## Build
## Building

To build this package we are using Cake.
### Prerequisites

General requirements:

* .NET Core 2.1, .NET Core 3.0, .NET Core 3.1, .NET 5 or .NET 6 for running the build

For building addins:

* .NET 9 SKD

For building website:

* Python 3

### Building addins

On Windows PowerShell run:

```powershell
./build.ps1
```

On OSX/Linux run:

```bash
.\build.sh
```

### Start website

On Windows PowerShell run:

```powershell
./build
./build.ps1 --target=website
```

On OSX/Linux run:

```bash
./build.sh
./build.sh --target=website
```

## Release

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

[GitFlow]: (http://nvie.com/posts/a-successful-git-branching-model/)
[GitFlow]: (https://nvie.com/posts/a-successful-git-branching-model/)
[Cake.Recipe documentation]: https://cake-contrib.github.io/Cake.Recipe/docs/usage/creating-release
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,15 +97,15 @@ In Cake Frosting they can be added using package references:
<PackageReference Include="Cake.Issues" Version="x.x.x" />
```

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

### Compatibility

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

See [Website](https://cakeissues.net/docs/usage/) for detailed usage instructions.
See [Website](https://cakeissues.net/latest/documentation/usage/) for detailed usage instructions.
## Support & Discussion

Expand All @@ -123,6 +123,7 @@ For questions and to discuss ideas & feature requests, use the [GitHub discussio
| [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. |
| [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. |
| [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. |
| [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. |
| [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. |
| [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. |
| [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. |
Expand All @@ -136,7 +137,7 @@ For questions and to discuss ideas & feature requests, use the [GitHub discussio
## API

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

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

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

0 comments on commit bc9c5aa

Please sign in to comment.