Skip to content

Commit f4bab9f

Browse files
JimBobSquarePantsJimBobSquarePants
committed
Update license, build scripts, and readme
1 parent 2734a14 commit f4bab9f

File tree

7 files changed

+178
-263
lines changed

7 files changed

+178
-263
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,15 @@
2828

2929
#### **Running tests and Debugging**
3030

31-
* Expected test output is pulled in as a submodule from the [ImageSharp.Tests.Images repository](https://github.com/SixLabors/Imagesharp.Tests.Images/tree/main/ReferenceOutput). To succesfully run tests, make sure that you have updated the submodules!
32-
* Debugging (running tests in Debug mode) is only supported on .NET Core 2.1, because of JIT Code Generation bugs like [dotnet/coreclr#16443](https://github.com/dotnet/coreclr/issues/16443) or [dotnet/coreclr#20657](https://github.com/dotnet/coreclr/issues/20657)
31+
* Expected test output is pulled in as a submodule from the [ImageSharp.Drawing.Tests.Images repository](https://github.com/SixLabors/ImageSharp.Drawing.Tests.Images/tree/main/ReferenceOutput). To succesfully run tests, make sure that you have updated the submodules!
3332

3433
#### **Do you have questions about consuming the library or the source code?**
3534

3635
* Ask any question about how to use SixLabors.ImageSharp in the [Help Discussions Channel](https://github.com/SixLabors/ImageSharp.Drawing/discussions?discussions_q=category%3AHelp).
3736

3837
#### Code of Conduct
3938
This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org/) to clarify expected behavior in our community.
40-
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
4139

42-
And please remember. SixLabors.ImageSharp.Drawing is the work of a very, very, small number of developers who struggle balancing time to contribute to the project with family time and work commitments. We encourage you to pitch in and help make our vision of simple accessible image processing available to all. Open Source can only exist with your help.
40+
And please remember. SixLabors.ImageSharp is the work of a very, very, small number of developers who struggle balancing time to contribute to the project with family time and work commitments. We encourage you to pitch in and help make our vision of simple accessible image processing available to all. Open Source can only exist with your help.
4341

4442
Thanks for reading!

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Ask a Question
4-
url: https://github.com/SixLabors/ImageSharp.Drawing/discussions?discussions_q=category%3AHelp
5-
about: Ask a question about this project.
3+
- name: Questions
4+
url: https://github.com/SixLabors/ImageSharp.Drawing/discussions/categories/q-a
5+
about: Ask the community for help.
66
- name: Feature Request
7-
url: https://github.com/SixLabors/ImageSharp.Drawing/discussions?discussions_q=category%3AIdeas
7+
url: https://github.com/SixLabors/ImageSharp.Drawing/discussions/categories/ideas
88
about: Share ideas for new features for this project.

‎.github/ISSUE_TEMPLATE/oss-bug-report.md‎

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,52 @@
1-
---
2-
name: "OSS : Bug Report"
3-
about: Create a report to help us improve the project.
4-
labels: needs triage
5-
6-
---
7-
8-
### Prerequisites
9-
10-
- [ ] I have written a descriptive issue title
11-
- [ ] I have verified that I am running the latest version of ImageSharp.Drawing
12-
- [ ] I have verified if the problem exist in both `DEBUG` and `RELEASE` mode
13-
- [ ] I have searched [open](https://github.com/SixLabors/ImageSharp.Drawing/issues) and [closed](https://github.com/SixLabors/ImageSharp.Drawing/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported
14-
15-
### Description
16-
<!-- A description of the bug or feature -->
17-
18-
### Steps to Reproduce
19-
<!-- List of steps, sample code, failing test or link to a project that reproduces the behavior -->
20-
21-
### System Configuration
22-
<!-- Tell us about the environment where you are experiencing the bug -->
23-
24-
- ImageSharp.Drawing version:
25-
- Other ImageSharp packages and versions:
26-
- Environment (Operating system, version and so on):
27-
- .NET Framework version:
28-
- Additional information:
29-
30-
<!-- Thanks for reporting the issue to ImageSharp.Drawing! -->
1+
name: "Bug Report"
2+
description: Create a report to help us improve the project. Issues are not guaranteed to be triaged.
3+
labels: ["needs triage"]
4+
body:
5+
- type: checkboxes
6+
attributes:
7+
label: Prerequisites
8+
options:
9+
- label: I have written a descriptive issue title
10+
required: true
11+
- label: I have verified that I am running the latest version of ImageSharp.Drawing
12+
required: true
13+
- label: I have verified if the problem exist in both `DEBUG` and `RELEASE` mode
14+
required: true
15+
- label: I have searched [open](https://github.com/SixLabors/ImageSharp.Drawing/issues) and [closed](https://github.com/SixLabors/ImageSharp.Drawing/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported
16+
required: true
17+
- type: input
18+
attributes:
19+
label: ImageSharp.Drawing version
20+
validations:
21+
required: true
22+
- type: input
23+
attributes:
24+
label: Other ImageSharp packages and versions
25+
validations:
26+
required: true
27+
- type: input
28+
attributes:
29+
label: Environment (Operating system, version and so on)
30+
validations:
31+
required: true
32+
- type: input
33+
attributes:
34+
label: .NET Framework version
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: Description
40+
description: A description of the bug
41+
validations:
42+
required: true
43+
- type: textarea
44+
attributes:
45+
label: Steps to Reproduce
46+
description: List of steps, sample code, failing test or link to a project that reproduces the behavior. Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues.
47+
validations:
48+
required: true
49+
- type: textarea
50+
attributes:
51+
label: Images
52+
description: Please upload images that can be used to reproduce issues in the area below. If the file type is not supported the file can be zipped and then uploaded instead.

‎.github/workflows/build-and-test.yml‎

Lines changed: 65 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,40 +9,65 @@ on:
99
pull_request:
1010
branches:
1111
- main
12+
types: [ labeled, opened, synchronize, reopened ]
1213
jobs:
1314
Build:
1415
strategy:
1516
matrix:
17+
isARM:
18+
- ${{ contains(github.event.pull_request.labels.*.name, 'arch:arm32') || contains(github.event.pull_request.labels.*.name, 'arch:arm64') }}
1619
options:
1720
- os: ubuntu-latest
18-
framework: netcoreapp3.1
21+
framework: net7.0
22+
sdk: 7.0.x
23+
sdk-preview: true
1924
runtime: -x64
2025
codecov: false
2126
- os: macos-latest
22-
framework: netcoreapp3.1
27+
framework: net7.0
28+
sdk: 7.0.x
29+
sdk-preview: true
2330
runtime: -x64
2431
codecov: false
2532
- os: windows-latest
26-
framework: netcoreapp3.1
33+
framework: net7.0
34+
sdk: 7.0.x
35+
sdk-preview: true
2736
runtime: -x64
28-
codecov: true
29-
- os: windows-latest
30-
framework: netcoreapp2.1
37+
codecov: false
38+
- os: buildjet-4vcpu-ubuntu-2204-arm
39+
framework: net7.0
40+
sdk: 7.0.x
41+
sdk-preview: true
3142
runtime: -x64
3243
codecov: false
33-
- os: windows-latest
34-
framework: net472
44+
- os: ubuntu-latest
45+
framework: net6.0
46+
sdk: 6.0.x
3547
runtime: -x64
3648
codecov: false
37-
- os: windows-latest
38-
framework: net472
39-
runtime: -x86
49+
- os: macos-latest
50+
framework: net6.0
51+
sdk: 6.0.x
52+
runtime: -x64
4053
codecov: false
54+
- os: windows-latest
55+
framework: net6.0
56+
sdk: 6.0.x
57+
runtime: -x64
58+
codecov: true
59+
exclude:
60+
- isARM: false
61+
options:
62+
os: buildjet-4vcpu-ubuntu-2204-arm
4163

4264
runs-on: ${{matrix.options.os}}
43-
if: "!contains(github.event.head_commit.message, '[skip ci]')"
4465

4566
steps:
67+
- name: Install libgdi+, which is required for tests running on ubuntu
68+
if: ${{ matrix.options.os == 'buildjet-4vcpu-ubuntu-2204-arm' }}
69+
run: sudo apt-get -y install libgdiplus libgif-dev libglib2.0-dev libcairo2-dev libtiff-dev libexif-dev
70+
4671
- name: Git Config
4772
shell: bash
4873
run: |
@@ -81,27 +106,49 @@ jobs:
81106
restore-keys: ${{ runner.os }}-nuget-
82107

83108
- name: DotNet Setup
109+
if: ${{ matrix.options.sdk-preview != true }}
84110
uses: actions/setup-dotnet@v3
85111
with:
86112
dotnet-version: |
87113
6.0.x
88-
5.0.x
89-
3.1.x
90-
2.1.x
114+
115+
- name: DotNet Setup Preview
116+
if: ${{ matrix.options.sdk-preview == true }}
117+
uses: actions/setup-dotnet@v3
118+
with:
119+
dotnet-version: |
120+
7.0.x
91121
92122
- name: DotNet Build
123+
if: ${{ matrix.options.sdk-preview != true }}
93124
shell: pwsh
94-
run: ./ci-build.ps1
125+
run: ./ci-build.ps1 "${{matrix.options.framework}}"
95126
env:
96127
SIXLABORS_TESTING: True
97128

129+
- name: DotNet Build Preview
130+
if: ${{ matrix.options.sdk-preview == true }}
131+
shell: pwsh
132+
run: ./ci-build.ps1 "${{matrix.options.framework}}"
133+
env:
134+
SIXLABORS_TESTING_PREVIEW: True
135+
98136
- name: DotNet Test
137+
if: ${{ matrix.options.sdk-preview != true }}
99138
shell: pwsh
100139
run: ./ci-test.ps1 "${{matrix.options.os}}" "${{matrix.options.framework}}" "${{matrix.options.runtime}}" "${{matrix.options.codecov}}"
101140
env:
102141
SIXLABORS_TESTING: True
103142
XUNIT_PATH: .\tests\ImageSharp.Drawing.Tests # Required for xunit
104143

144+
- name: DotNet Test Preview
145+
if: ${{ matrix.options.sdk-preview == true }}
146+
shell: pwsh
147+
run: ./ci-test.ps1 "${{matrix.options.os}}" "${{matrix.options.framework}}" "${{matrix.options.runtime}}" "${{matrix.options.codecov}}"
148+
env:
149+
SIXLABORS_TESTING_PREVIEW: True
150+
XUNIT_PATH: .\tests\ImageSharp.Drawing.Tests # Required for xunit
151+
105152
- name: Export Failed Output
106153
uses: actions/upload-artifact@v3
107154
if: failure()
@@ -115,6 +162,7 @@ jobs:
115162
with:
116163
flags: unittests
117164

165+
118166
Publish:
119167
needs: [Build]
120168

@@ -150,12 +198,6 @@ jobs:
150198
shell: pwsh
151199
run: ./ci-pack.ps1
152200

153-
- name: MyGet Publish
154-
shell: pwsh
155-
run: |
156-
dotnet nuget push .\artifacts\*.nupkg -k ${{secrets.MYGET_TOKEN}} -s https://www.myget.org/F/sixlabors/api/v2/package
157-
dotnet nuget push .\artifacts\*.snupkg -k ${{secrets.MYGET_TOKEN}} -s https://www.myget.org/F/sixlabors/api/v3/index.json
158-
159201
- name: Feedz Publish
160202
shell: pwsh
161203
run: |
@@ -168,3 +210,4 @@ jobs:
168210
run: |
169211
dotnet nuget push .\artifacts\*.nupkg -k ${{secrets.NUGET_TOKEN}} -s https://api.nuget.org/v3/index.json --skip-duplicate
170212
dotnet nuget push .\artifacts\*.snupkg -k ${{secrets.NUGET_TOKEN}} -s https://api.nuget.org/v3/index.json --skip-duplicate
213+

0 commit comments

Comments
 (0)