Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danger/danger-swift
⚠️ Stop saying "you forgot to …" in code review
https://github.com/danger/danger-swift
Last synced: 3 months ago
JSON representation
⚠️ Stop saying "you forgot to …" in code review
- Host: GitHub
- URL: https://github.com/danger/danger-swift
- Owner: danger
- License: mit
- Created: 2017-08-24T21:30:03.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T17:10:41.000Z (7 months ago)
- Last Synced: 2024-05-19T08:06:15.693Z (6 months ago)
- Language: Swift
- Homepage: https://danger.systems/swift/
- Size: 2.12 MB
- Stars: 1,019
- Watchers: 16
- Forks: 134
- Open Issues: 81
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-system-swift - danger-swift
README
Formalize your Pull Request etiquette.
Write your Dangerfiles in Swift.
### Requirements
Latest version requires Swift 5.5
If you are using an older Swift, use the supported version according to next table.
| Swift version | Danger support version |
| ------------- | ---------------------- |
| 5.4 | v3.15.0 |
| 5.3 | v3.13.0 |
| 5.2 | v3.11.1 |
| 5.1 | v3.8.0 |
| 4.2 | v2.0.7 |
| 4.1 | v0.4.1 |
| 4.0 | v0.3.6 |
### What it looks like today
You can make a Dangerfile that looks through PR metadata, it's fully typed.
```swift
import Danger
let danger = Danger()
let allSourceFiles = danger.git.modifiedFiles + danger.git.createdFiles
let changelogChanged = allSourceFiles.contains("CHANGELOG.md")
let sourceChanges = allSourceFiles.first(where: { $0.hasPrefix("Sources") })
if !changelogChanged && sourceChanges != nil {
warn("No CHANGELOG entry added.")
}
// You can use these functions to send feedback:
message("Highlight something in the table")
warn("Something pretty bad, but not important enough to fail the build")
fail("Something that must be changed")
markdown("Free-form markdown that goes under the table, so you can do whatever.")
```
### Using Danger Swift
All of the docs are on the user-facing website: https://danger.systems/swift/
### Commands
- `danger-swift ci` - Use this on CI
- `danger-swift pr https://github.com/Moya/Harvey/pull/23` - Use this to build your Dangerfile
- `danger-swift local` - Use this to run danger against your local changes from master
- `danger-swift edit` - Creates a temporary Xcode project for working on a Dangerfile
#### Plugins
Infrastructure exists to support plugins, which can help you avoid repeating the same Danger rules across separate
repos.
e.g. A plugin implemented with the following at https://github.com/username/DangerPlugin.git.
```swift
// DangerPlugin.swift
import Danger
public struct DangerPlugin {
let danger = Danger()
public static func doYourThing() {
// Code goes here
}
}
```
#### Swift Package Manager (More performant)
You can use Swift PM to install both `danger-swift` and your plugins:
- Install Danger JS
```bash
$ npm install -g danger
```
- Add to your `Package.swift`:
```swift
let package = Package(
...
products: [
...
.library(name: "DangerDeps[Product name (optional)]", type: .dynamic, targets: ["DangerDependencies"]), // dev
...
],
dependencies: [
...
.package(url: "https://github.com/danger/swift.git", from: "3.0.0"), // dev
// Danger Plugins
.package(url: "https://github.com/username/DangerPlugin.git", from: "0.1.0") // dev
...
],
targets: [
.target(name: "DangerDependencies", dependencies: ["Danger", "DangerPlugin"]), // dev
...
]
)
```
- Add the correct import to your `Dangerfile.swift`:
```swift
import DangerPlugin
DangerPlugin.doYourThing()
```
- Create a folder called `DangerDependencies` in `Sources` with an empty file inside like
[Fake.swift](Sources/Danger-Swift/Fake.swift)
- To run `Danger` use `swift run danger-swift command`
- **(Recommended)** If you are using Swift PM to distribute your framework, use
[Rocket](https://github.com/f-meloni/Rocket), or a similar tool, to comment out all the dev dependencies from your
`Package.swift`. This prevents these dev dependencies from being downloaded and compiled with your framework by
consumers.
- **(Recommended)** cache the `.build` folder on your repo
#### Marathon (Easy to use)
By suffixing `package: [url]` to an import, you can directly import Swift PM package as a dependency
For example, a plugin could be used by the following.
```swift
// Dangerfile.swift
import DangerPlugin // package: https://github.com/username/DangerPlugin.git
DangerPlugin.doYourThing()
```
You can see an [example danger-swift plugin](https://github.com/ashfurrow/danger-swiftlint#danger-swiftlint).
**(Recommended)** Cache the `~/.danger-swift` folder
### Setup
For a Mac:
```sh
# Install danger-swift, and a bundled danger-js locally
brew install danger/tap/danger-swift
# Run danger
danger-swift ci
```
For Linux:
```sh
# Install danger-swift
git clone https://github.com/danger/danger-swift.git
cd danger-swift
make install
# Install danger-js
npm install -g danger
# Run danger
danger-swift ci
```
GitHub Actions
You can add danger/swift to your actions
```yml
jobs:
build:
runs-on: ubuntu-latest
name: "Run Danger"
steps:
- uses: actions/checkout@v1
- name: Danger
uses: danger/[email protected]
with:
args: --failOnErrors --no-publish-check
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Danger has two different pre built images that you can use with your action:
- https://github.com/orgs/danger/packages/container/package/danger-swift
- https://github.com/orgs/danger/packages/container/package/danger-swift-with-swiftlint (Danger + Swiftlint)
In order to import one of those use the `docker://` prefix
```yml
jobs:
build:
runs-on: ubuntu-latest
name: "Run Danger"
steps:
- uses: actions/checkout@v1
- name: Danger
uses: docker://ghcr.io/danger/danger-swift:3.15.0
with:
args: --failOnErrors --no-publish-check
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
#### Local compiled danger-js
To use a local compiled copy of danger-js use the `danger-js-path` argument:
```bash
danger-swift command --danger-js-path path/to/danger-js
```
#### Current working directory
Many people prefer using Danger within a Swift Package via SPM, because is more performant.
When doing so, however, having a `Package.swift` in the root folder can be annoying, especially now that Xcode (since Xcode 11) doesn't show a `xcproj` (or `xcworkspace`) on the Open Recents menu when there is a `Package.swift` in the same folder.
With the `--cwd` parameter you can specify a working directory.
This allows you to have your `Package.swift` in another directory and still run danger-swift as it was executed from your project root directory.
```swift
swift run danger-swift command --cwd path/to/working-directory
```
Note that to do this, you must run `danger-swift` from the directory where the `Package.swift` is located, and pass the top-level directory relative to this directory to the `--cwd` command-line switch. For example, if you create a folder named **Danger** in the top level of your repo for these files, you would need to `cd Danger` and then run the command `[swift run] danger-swift cmd --cwd ..` to tell Danger that it should look at the directory above where the command was executed to correctly invoke the tool.
#### Dev
You need to be using Xcode >= 13.2.1.
```sh
git clone https://github.com/danger/danger-swift.git
cd danger-swift
swift build
swift run komondor install
swift package generate-xcodeproj
open danger-swift.xcodeproj
```
Then I tend to run `danger-swift` using `swift run`:
```sh
swift run danger-swift pr https://github.com/danger/swift/pull/95
```
If you want to emulate how DangerJS's `process` will work entirely, then use:
```sh
swift build && cat Fixtures/eidolon_609.json | ./.build/debug/danger-swift
```
#### Deploying
Run `swift run rocket $VERSION` on `master` e.g. `swift run rocket 1.0.0`
### Maintainer
Danger Swift is maintained by [@f-meloni](https://github.com/f-meloni), and maybe you?