Skip to content

Commit 292f58b

Browse files
committed
Licenses: REUSE compliance; CI: test licensing and encoding
1 parent 56a0973 commit 292f58b

113 files changed

Lines changed: 676 additions & 66 deletions

File tree

Some content is hidden

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

.config/dotnet-tools.json.license

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
2+
3+
SPDX-License-Identifier: MIT

.dockerignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
2+
#
3+
# SPDX-License-Identifier: MIT
4+
15
.git
26
.idea
37
.vs

.editorconfig

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
2+
#
3+
# SPDX-License-Identifier: MIT
4+
15
root = true
26

37
[*]

.github/workflows/docker.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
2+
#
3+
# SPDX-License-Identifier: MIT
4+
15
name: Docker
26
on:
37
push:

.github/workflows/main.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
2+
#
3+
# SPDX-License-Identifier: MIT
4+
15
name: Main
26
on:
37
push:
@@ -38,3 +42,17 @@ jobs:
3842
- name: Test
3943
run: dotnet test
4044
timeout-minutes: 10
45+
encoding:
46+
runs-on: ubuntu-22.04
47+
steps:
48+
- uses: actions/checkout@v4
49+
- name: Verify encoding
50+
shell: pwsh
51+
run: scripts/Test-Encoding.ps1
52+
licenses:
53+
runs-on: ubuntu-22.04
54+
steps:
55+
- name: Check out the sources
56+
uses: actions/checkout@v4
57+
- name: REUSE license check
58+
uses: fsfe/reuse-action@v3

.github/workflows/release.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
2+
#
3+
# SPDX-License-Identifier: MIT
4+
15
name: Release
26
on:
37
push:

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
2+
#
3+
# SPDX-License-Identifier: MIT
4+
15
/.idea/
26
/.vscode/
37
/logs/

.reuse/dep5

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2+
Upstream-Name: Emulsion
3+
Upstream-Contact: Friedrich von Never <friedrich@fornever.me>
4+
Source: https://github.com/codingteam/emulsion
5+
6+
Files: .idea/**/*
7+
Copyright: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
8+
License: MIT
9+
10+
Files: *.DotSettings
11+
Copyright: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
12+
License: MIT

CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Changelog
1+
<!--
2+
SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
3+
4+
SPDX-License-Identifier: MIT
5+
-->
6+
7+
# Changelog
28

39
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
410
and this project adheres to [Semantic

CONTRIBUTING.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
Contributor Guide
1+
<!--
2+
SPDX-FileCopyrightText: 2024 Emulsion contributors <https://github.com/codingteam/emulsion>
3+
4+
SPDX-License-Identifier: MIT
5+
-->
6+
7+
Contributor Guide
28
=================
39

410
Prerequisites
@@ -32,6 +38,25 @@ Execute the tests using the following shell command:
3238
$ dotnet test
3339
```
3440

41+
License Automation
42+
------------------
43+
<!-- REUSE-IgnoreStart -->
44+
If the CI asks you to update the file licenses, follow one of these:
45+
1. Update the headers manually (look at the existing files), something like this:
46+
```fsharp
47+
// SPDX-FileCopyrightText: %year% %your name% <%your contact info, e.g. email%>
48+
//
49+
// SPDX-License-Identifier: MIT
50+
```
51+
(accommodate to the file's comment style if required).
52+
2. Alternately, use [REUSE][reuse] tool:
53+
```console
54+
$ reuse annotate --license MIT --copyright '%your name% <%your contact info, e.g. email%>' %file names to annotate%
55+
```
56+
57+
(Feel free to attribute the changes to "Emulsion contributors <https://github.com/codingteam/emulsion>" instead of your name in a multi-author file, or if you don't want your name to be mentioned in the project's source: this doesn't mean you'll lose the copyright.)
58+
<!-- REUSE-IgnoreEnd -->
59+
3560
Docker Publish
3661
--------------
3762
To build and push the container to Docker Hub, use the following shell commands:

0 commit comments

Comments
 (0)