michael/swift-bump-version
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

feat: Working on command-line documentation.
Some checks failed
CI / Ubuntu (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Michael Housh
2024-12-27 14:51:55 -05:00
parent 8d73287a60
commit 4420bd428a
28 changed files with 674 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
Sources/CliClient/Documentation.docc/Articles/ManualPlugins.md
View File

@@ -1,12 +1,12 @@
# Manual Plugins
There are two plugins that are included that can be ran manually, if the build tool plugin does not fit
your use case.
There are two plugins that are included that can be ran manually, if the build tool plugin does not
fit your use case.
## Generate Version
The `generate-version` plugin will create a `Version.swift` file in the given target. You can
run it by running the following command.
The `generate-version` plugin will create a `Version.swift` file in the given target. You can run it
by running the following command.
```bash
swift package --disable-sandbox \
@@ -32,16 +32,17 @@ swift package --disable-sandbox \
## Options
Both manual versions also allow the following options to customize the operation, the
options need to come after the plugin name.
Both manual versions also allow the following options to customize the operation, the options need
to come after the plugin name.
| Option | Description |
| ------ | ----------- |
| --dry-run | Do not write to any files, but describe where values would be written |
| --filename | Override the file name to be written in the target directory |
| --verbose | Increase the logging output |
| Option | Description |
| ---------- | --------------------------------------------------------------------- |
| --dry-run | Do not write to any files, but describe where values would be written |
| --filename | Override the file name to be written in the target directory |
| --verbose | Increase the logging output |
### Example with options
```bash
swift package \
--allow-writing-to-package-directory \