Skip to content

Commit b658d54

Browse files
committed
Rename primary branch to main, use node20, update tsconfig
1 parent 99a53ca commit b658d54

14 files changed

Lines changed: 145 additions & 38 deletions

File tree

File renamed without changes.

.github/actions/generate-action-code/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ runs:
66
steps:
77
- uses: actions/setup-node@v3
88
with:
9-
node-version: 16
9+
node-version: 20
1010
check-latest: true
1111
cache: 'npm'
1212
- name: Generate action code

.github/workflows/codeql-analysis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ name: CodeQL
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [ main ]
66
paths-ignore: [ 'dist/*.js' ]
77
pull_request:
88
# The branches below must be a subset of the branches above
9-
branches: [ master ]
9+
branches: [ main ]
1010
schedule:
1111
- cron: '15 11 * * 1'
1212

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Deploy Action Code
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [ main ]
66
paths-ignore: [ 'dist/*.js' ]
77

88
jobs:

.github/workflows/tag-update.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ jobs:
88
update-tags:
99
name: Update Running Releases
1010
runs-on: ubuntu-latest
11+
if: ${{ github.event.release.prerelease == false }}
1112
steps:
1213
- uses: actions/checkout@v4
13-
- uses: sersoft-gmbh/running-release-tags-action@v2
14-
if: ${{ github.event.release.prerelease == false }}
14+
- uses: sersoft-gmbh/running-release-tags-action@v3
1515
with:
1616
update-full-release: true
1717
github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ name: Tests
22

33
on:
44
push:
5-
branches: [ master ]
5+
branches: [ main ]
66
paths:
77
- 'dist/*.js'
88
- '.github/actions/generate-action-code/**'
99
- '.github/workflows/tests.yml'
1010
pull_request:
11-
branches: [ master ]
11+
branches: [ main ]
1212

1313
jobs:
1414
test-spm:
@@ -29,7 +29,7 @@ jobs:
2929
- name: Generate action code
3030
if: ${{ github.event_name == 'pull_request' }}
3131
uses: ./.github/actions/generate-action-code
32-
- uses: sersoft-gmbh/swifty-docs-action@master
32+
- uses: sersoft-gmbh/swifty-docs-action@main
3333
if: ${{ github.event_name == 'push' }}
3434
with:
3535
package-path: ${{ env.INPUT_PACKAGE_PATH }}
@@ -67,7 +67,7 @@ jobs:
6767
- name: Generate action code
6868
if: ${{ github.event_name == 'pull_request' }}
6969
uses: ./.github/actions/generate-action-code
70-
- uses: sersoft-gmbh/swifty-docs-action@master
70+
- uses: sersoft-gmbh/swifty-docs-action@main
7171
if: ${{ github.event_name == 'push' }}
7272
with:
7373
package-path: ${{ env.INPUT_PACKAGE_PATH }}

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This action generates documentation for a Swift package using `docc`.
66

77
**Important:** The package must use the [Swift-DocC Plugin](https://github.com/apple/swift-docc-plugin) unless `xcodebuild` is used!
88

9-
**Note:** Version 2 of this action replaced `jazzy` with `docc`! Use `@v1` to use `jazzy`.
9+
**Note:** As of version 2, this action uses `docc` instead of `jazzy`! Use `@v1` to use `jazzy`.
1010

1111
## Inputs
1212

@@ -73,7 +73,7 @@ The path to the output directory.
7373

7474
Use the following snippet in a Swift package repository to generate documentation for all products of your Swift package:
7575
```yaml
76-
uses: sersoft-gmbh/swifty-docs-action@v2
76+
uses: sersoft-gmbh/swifty-docs-action@v3
7777
with:
7878
output: docs
7979
```

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ inputs:
4747
description: The path to the output folder.
4848
required: false
4949
runs:
50-
using: node16
50+
using: node20
5151
main: dist/index.js
5252
branding:
5353
color: orange

dist/index.js

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3434
};
3535
Object.defineProperty(exports, "__esModule", ({ value: true }));
3636
const core = __importStar(__nccwpck_require__(186));
37-
const exec = __importStar(__nccwpck_require__(514));
37+
const exec_1 = __nccwpck_require__(514);
3838
const path_1 = __importDefault(__nccwpck_require__(17));
3939
async function runCmd(cmd, args, cwd) {
40-
const output = await exec.getExecOutput(cmd, args, {
40+
const output = await (0, exec_1.getExecOutput)(cmd, args, {
4141
cwd: cwd,
4242
silent: !core.isDebug(),
4343
});
@@ -73,9 +73,8 @@ async function generateDocsUsingSPM(packagePath, targets, options) {
7373
if (options.outputPath)
7474
args.push('--allow-writing-to-directory', options.outputPath);
7575
args.push('generate-documentation');
76-
if (targets.length > 0) {
76+
if (targets.length > 0)
7777
args.push(...targets.flatMap(t => ['--target', t]));
78-
}
7978
args.push(...docCFlags(options, true));
8079
return await runCmd('swift', args, packagePath);
8180
}

dist/license.txt

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
@actions/core
2+
MIT
3+
The MIT License (MIT)
4+
5+
Copyright 2019 GitHub
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8+
9+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10+
11+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
12+
13+
@actions/exec
14+
MIT
15+
The MIT License (MIT)
16+
17+
Copyright 2019 GitHub
18+
19+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
20+
21+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
22+
23+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24+
25+
@actions/http-client
26+
MIT
27+
Actions Http Client for Node.js
28+
29+
Copyright (c) GitHub, Inc.
30+
31+
All rights reserved.
32+
33+
MIT License
34+
35+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
36+
associated documentation files (the "Software"), to deal in the Software without restriction,
37+
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
38+
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
39+
subject to the following conditions:
40+
41+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
42+
43+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
44+
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
45+
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
46+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
47+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
48+
49+
50+
@actions/io
51+
MIT
52+
The MIT License (MIT)
53+
54+
Copyright 2019 GitHub
55+
56+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
57+
58+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
59+
60+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
61+
62+
tunnel
63+
MIT
64+
The MIT License (MIT)
65+
66+
Copyright (c) 2012 Koichi Kobayashi
67+
68+
Permission is hereby granted, free of charge, to any person obtaining a copy
69+
of this software and associated documentation files (the "Software"), to deal
70+
in the Software without restriction, including without limitation the rights
71+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
72+
copies of the Software, and to permit persons to whom the Software is
73+
furnished to do so, subject to the following conditions:
74+
75+
The above copyright notice and this permission notice shall be included in
76+
all copies or substantial portions of the Software.
77+
78+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
79+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
80+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
81+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
82+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
83+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
84+
THE SOFTWARE.
85+
86+
87+
uuid
88+
MIT
89+
The MIT License (MIT)
90+
91+
Copyright (c) 2010-2020 Robert Kieffer and other contributors
92+
93+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
94+
95+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
96+
97+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)