Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ jobs:
- name: Prepare the action
run: ./scripts/prep-gh-action.sh --install-swiftly
- name: Generate Swiftly CLI Reference and Check for Differences
run: swift package plugin --allow-writing-to-package-directory generate-docs-reference && bash -c 'git config --global --add safe.directory $(pwd)' && git diff --exit-code Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md || (echo "The documentation hasn't been updated with the latest swiftly command-line reference. Please run `swift package plugin generate-docs-reference` and commit/push the changes."; exit 1)
run: swift package plugin --allow-writing-to-package-directory generate-docs-reference && bash -c 'git config --global --add safe.directory $(pwd)' && git diff --exit-code Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md || (echo "The documentation hasn't been updated with the latest swiftly command-line reference. Please run 'swift package plugin generate-docs-reference' and commit/push the changes."; exit 1)
- name: Generate Documentation Set
run: swift package --allow-writing-to-directory .build/docs generate-documentation --target SwiftlyDocs --output-path .build/docs
- name: Upload Documentation Artifacts
Expand Down
40 changes: 34 additions & 6 deletions Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ swiftly [--version] [--help]
Install a new toolchain.

```
swiftly install [<version>] [--use] [--verify|no-verify] [--post-install-file=<post-install-file>] [--progress-file=<progress-file>] [--format=<format>] [--assume-yes] [--verbose] [--version] [--help]
swiftly install [<version>] [--use] [--verify] [--no-verify] [--post-install-file=<post-install-file>] [--progress-file=<progress-file>] [--format=<format>] [--assume-yes] [--verbose] [--version] [--help]
```

**version:**
Expand Down Expand Up @@ -67,9 +67,14 @@ NOTE: Swiftly downloads toolchains to a temporary file that it later cleans duri
*Mark the newly installed toolchain as in-use.*


**--verify|no-verify:**
**--verify:**

*Verify the toolchain's PGP signature before proceeding with installation.*
*Verify (or not) the toolchain's PGP signature before proceeding with installation.*


**--no-verify:**

*Verify (or not) the toolchain's PGP signature before proceeding with installation.*


**--post-install-file=\<post-install-file\>:**
Expand Down Expand Up @@ -365,7 +370,7 @@ The installed snapshots for a given development branch can be listed by specifyi
Update an installed toolchain to a newer version.

```
swiftly update [<toolchain>] [--assume-yes] [--verbose] [--verify|no-verify] [--post-install-file=<post-install-file>] [--version] [--help]
swiftly update [<toolchain>] [--assume-yes] [--verbose] [--verify] [--no-verify] [--post-install-file=<post-install-file>] [--version] [--help]
```

**toolchain:**
Expand Down Expand Up @@ -416,9 +421,14 @@ A specific snapshot toolchain can be updated by including the date:
*Enable verbose reporting from swiftly*


**--verify|no-verify:**
**--verify:**

*Verify (or not) the toolchain's PGP signature before proceeding with installation.*


*Verify the toolchain's PGP signature before proceeding with installation.*
**--no-verify:**

*Verify (or not) the toolchain's PGP signature before proceeding with installation.*


**--post-install-file=\<post-install-file\>:**
Expand Down Expand Up @@ -660,3 +670,21 @@ Unlinks swiftly until swiftly is linked again with:



## help

Show subcommand help information.

```
swiftly help [<subcommands>...] [--version]
```

**subcommands:**


**--version:**

*Show the version.*




125 changes: 85 additions & 40 deletions Package.resolved

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Sources/Swiftly/Install.swift
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ struct Install: SwiftlyCommand {

@Flag(
inversion: .prefixedNo,
help: "Verify the toolchain's PGP signature before proceeding with installation."
help: "Verify (or not) the toolchain's PGP signature before proceeding with installation."
)
var verify = true

Expand Down
2 changes: 1 addition & 1 deletion Sources/Swiftly/Update.swift
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ struct Update: SwiftlyCommand {

@OptionGroup var root: GlobalOptions

@Flag(inversion: .prefixedNo, help: "Verify the toolchain's PGP signature before proceeding with installation.")
@Flag(inversion: .prefixedNo, help: "Verify (or not) the toolchain's PGP signature before proceeding with installation.")
var verify = true

@Option(help: ArgumentHelp(
Expand Down
3 changes: 3 additions & 0 deletions Sources/SwiftlyCore/dscl.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"kind": "long",
"name": "datasource"
},
"parsingStrategy": "default",
"valueName": "datasource",
"isOptional": true,
"isRepeating": false,
Expand All @@ -32,13 +33,15 @@
"shouldDisplay": true,
"arguments": [
{
"parsingStrategy": "default",
"valueName": "path",
"shouldDisplay": true,
"kind": "positional",
"isOptional": true,
"isRepeating": false
},
{
"parsingStrategy": "default",
"valueName": "key",
"shouldDisplay": true,
"kind": "positional",
Expand Down
2 changes: 2 additions & 0 deletions Sources/SwiftlyCore/getent.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@
"shouldDisplay": true,
"arguments": [
{
"parsingStrategy": "default",
"valueName": "database",
"isOptional": false,
"isRepeating": false,
"kind": "positional",
"shouldDisplay": true
},
{
"parsingStrategy": "default",
"valueName": "key",
"isOptional": false,
"isRepeating": true,
Expand Down
Loading