Skip to content

Commit fca8278

Browse files
PSchmiedmayerPSchmiedmayer
authored
Update to Apodini 0.4.0 and make REUSE compliance (#1)
* Update to Apodini 0.4.0 and make REUSE compliance * Execute no tests on macOS
1 parent 69cc488 commit fca8278

24 files changed

Lines changed: 318 additions & 79 deletions

‎.github/pull_request_template.md‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
1+
<!--
2+
3+
This source file is part of the Apodini Leaf open source project
4+
5+
SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
6+
7+
SPDX-License-Identifier: MIT
8+
9+
-->
10+
111
# *Name of the PR*
212

3-
## :recycle: Current situation
13+
## :recycle: Current situation & Problem
414
*Describe the current situation (if possible with and exemplary (or real) code snippet and/or where this is used)*
515

616
## :bulb: Proposed solution
7-
*Describe the solution (if possible with and exemplary (or real) code snippet)*
8-
9-
### Problem that is solved
10-
*Provide a description and link issues that are solved*
17+
*Describe the solution and how this affects the project and internal structure*
1118

12-
### Implications
13-
*Describe the implications, e.g. refactoring*
19+
## :gear: Release Notes
20+
*Add a short summary of the feature as well as possible migration guides if this is a breaking change so this section can be added to the release notes.*
21+
*Include code snippets that provide examples of the feature implemented if it appends or changes the public interface.*
1422

1523
## :heavy_plus_sign: Additional Information
1624
*Provide some additional information if possible*

‎.github/release-drafter.yml‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
19
branches: [release]
210
name-template: '$NEXT_PATCH_VERSION'
311
tag-template: '$NEXT_PATCH_VERSION'
412
categories:
5-
- title: '🚀 Features'
13+
- title: 'Semantic Version Major'
14+
labels:
15+
- 'needs version bump'
16+
- title: 'Semantic Version Minor'
617
labels:
718
- 'feature'
819
- 'enhancement'
9-
- title: '🐛 Bug Fixes'
20+
- title: 'Other Changes'
1021
labels:
1122
- 'fix'
1223
- 'bugfix'
1324
- 'bug'
14-
- title: '🧰 Maintenance'
15-
label: 'chore'
25+
- 'documentation'
1626
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
1727
template: |
1828
## Changes
1929
20-
$CHANGES
30+
$CHANGES

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

Lines changed: 23 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,35 @@
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
19
name: Build and Test
210

311
on:
412
push:
513
branches:
614
- develop
7-
- release
815
pull_request:
916
branches:
1017
- develop
11-
- release
1218
workflow_dispatch:
1319

1420
jobs:
15-
latest-beta-swift-version:
16-
name: Latest (Beta) Swift Version
17-
runs-on: macos-11
18-
steps:
19-
- uses: actions/checkout@v2
20-
- uses: maxim-lobanov/setup-xcode@v1.2.3
21-
with:
22-
xcode-version: latest
23-
- uses: actions/cache@v2
24-
with:
25-
path: .build
26-
key: ${{ runner.os }}-spm-${{ hashFiles('**/Package.resolved') }}
27-
- name: Check Xcode version
28-
run: xcodebuild -version
29-
- name: Check Swift version
30-
run: swift --version
31-
- name: Debug Build & Test
32-
run: swift test
3321
macos:
3422
name: macOS ${{ matrix.configuration }}
3523
runs-on: macos-11
3624
strategy:
3725
fail-fast: false
3826
matrix:
39-
configuration: [debug, release, release_testing]
27+
configuration: [debug, release]
4028
steps:
4129
- uses: actions/checkout@v2
4230
- uses: maxim-lobanov/setup-xcode@v1.2.3
4331
with:
44-
xcode-version: latest-stable
32+
xcode-version: latest
4533
- uses: actions/cache@v2
4634
with:
4735
path: .build
@@ -53,27 +41,25 @@ jobs:
5341
- name: Release Build
5442
if: matrix.configuration == 'release'
5543
run: swift build -c release
56-
- name: Release Build & Test
57-
if: matrix.configuration == 'release_testing'
58-
run: swift test -c release -Xswiftc -enable-testing -Xswiftc -DRELEASE_TESTING
59-
- name: Debug Build & Test
44+
- name: Debug Build
6045
if: matrix.configuration == 'debug'
61-
run: swift test -c debug --enable-code-coverage -Xswiftc -DCOVERAGE
62-
- name: Convert coverage report
46+
run: swift build -c debug
47+
- name: Test Generating Docs
6348
if: matrix.configuration == 'debug'
64-
run: xcrun llvm-cov export -format="lcov" .build/debug/ApodiniLeafPackageTests.xctest/Contents/MacOS/ApodiniLeafPackageTests -instr-profile .build/debug/codecov/default.profdata > coverage.lcov
65-
- name: Upload coverage to Codecov
66-
uses: codecov/codecov-action@v1
49+
run: |
50+
xcodebuild docbuild -scheme ApodiniLeaf -destination platform=macOS,arch=x86_64 -derivedDataPath ./.xcodebuild
51+
cp -r $(find ./.xcodebuild -type d -name 'ApodiniLeaf.doccarchive') ./ApodiniLeaf.doccarchive
52+
echo "The DocC archive can be found at ./ApodiniLeaf.doccarchive"
6753
linux:
6854
name: Linux ${{ matrix.linux }} ${{ matrix.configuration }}
6955
container:
70-
image: swift:${{ matrix.linux }}
56+
image: swiftlang/swift:nightly-5.5-${{ matrix.linux }}
7157
runs-on: ubuntu-latest
7258
strategy:
7359
fail-fast: false
7460
matrix:
75-
linux: [bionic, xenial, focal, amazonlinux2, centos8]
76-
configuration: [debug, release]
61+
linux: [bionic, focal, amazonlinux2, centos8]
62+
configuration: [debug, release, release_testing]
7763
steps:
7864
- uses: actions/checkout@v2
7965
- uses: actions/cache@v2
@@ -85,6 +71,9 @@ jobs:
8571
- name: Release Build
8672
if: matrix.configuration == 'release'
8773
run: swift build -c release
74+
- name: Release Build & Test
75+
if: matrix.configuration == 'release_testing'
76+
run: swift test -c release -Xswiftc -enable-testing
8877
- name: Debug Build & Test
8978
if: matrix.configuration == 'debug'
9079
run: swift test -c debug

‎.github/workflows/docs.yml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1-
name: Publish Documentation
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
9+
name: Generate Docs
210

311
on:
412
release:
513
types: [published]
14+
workflow_dispatch:
615

716
jobs:
8-
deploy_docs:
17+
generatedocs:
18+
name: Generate Docs
919
runs-on: macos-11
1020
steps:
1121
- uses: actions/checkout@v2

‎.github/workflows/release-drafter.yml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
19
name: Release Drafter
210

311
on:
412
push:
513
branches:
6-
- release
14+
- develop
715

816
jobs:
917
update_release_draft:

‎.github/workflows/release.yml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
19
name: Create Release
210

311
on:
@@ -9,7 +17,7 @@ jobs:
917
build:
1018
runs-on: ubuntu-latest
1119
steps:
12-
- name: GH Release
20+
- name: Create GitHub Release
1321
uses: softprops/action-gh-release@v0.1.5
1422
env:
1523
GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}

‎.github/workflows/reuseaction.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
9+
name: REUSE Compliance Check
10+
11+
on:
12+
pull_request:
13+
workflow_dispatch:
14+
15+
jobs:
16+
reuse:
17+
name: REUSE Compliance Check
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v2
21+
- name: REUSE Compliance Check
22+
uses: fsfe/reuse-action@v1

‎.github/workflows/spm-update.yml‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
19
name: Swift Package Update
210

311
on:
@@ -8,6 +16,8 @@ on:
816
jobs:
917
createPR:
1018
name: Create Pull Request
19+
container:
20+
image: swiftlang/swift:nightly-5.5-focal
1121
runs-on: ubuntu-latest
1222
steps:
1323
- uses: actions/checkout@v2
@@ -24,6 +34,7 @@ jobs:
2434
delete-branch: true
2535
base: develop
2636
branch: bots/update-dependencies
27-
assignees: PSchmiedmayer
28-
committer: PSchmiedmayer <PSchmiedmayer@users.noreply.github.com>
29-
author: PSchmiedmayer <PSchmiedmayer@users.noreply.github.com>
37+
assignees: ApodiniBot
38+
committer: ApodiniBot <ApodiniBot@users.noreply.github.com>
39+
author: ApodiniBot <ApodiniBot@users.noreply.github.com>
40+
reviewers: PSchmiedmayer

‎.github/workflows/swiftlint.yml‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
19
name: SwiftLint
210

311
on:
412
pull_request:
5-
paths:
6-
- '.github/workflows/swiftlint.yml'
7-
- '.swiftlint.yml'
8-
- '**/*.swift'
13+
workflow_dispatch:
914

1015
jobs:
1116
swiftlint:
17+
name: SwiftLint
1218
runs-on: ubuntu-latest
1319
steps:
1420
- uses: actions/checkout@v1
1521
- name: GitHub Action for SwiftLint
16-
uses: norio-nomura/action-swiftlint@3.1.0
22+
uses: norio-nomura/action-swiftlint@3.2.1
1723
with:
1824
args: --strict
1925
env:

‎.gitignore‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
#
2+
# This source file is part of the Apodini Leaf open source project
3+
#
4+
# SPDX-FileCopyrightText: 2021 Paul Schmiedmayer and the project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
5+
#
6+
# SPDX-License-Identifier: MIT
7+
#
8+
19
# Apodini .gitignore File
210

311
# Swift Package Manager
@@ -6,14 +14,18 @@ Package.resolved
614
.swiftpm
715
.build/
816

17+
# IDE related folders
18+
.idea
19+
920
# Xcode User settings
1021
xcuserdata/
1122

1223
# Other files
1324
.DS_Store
25+
.env
1426

15-
# Fastlane
16-
fastlane/report.xml
17-
fastlane/Preview.html
18-
fastlane/screenshots/**/*.png
19-
fastlane/test_output
27+
# Documentation generation
28+
.xcodebuild/
29+
docs/
30+
docc2html/
31+
*.doccarchive

0 commit comments

Comments
 (0)