Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #440

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

clayellis-cricut
Copy link

@clayellis-cricut clayellis-cricut commented May 17, 2021

I added a few missing details to the README when using the --cwd parameter, as well as pointed out that Danger will automatically search for your Dangerfile in a danger directory, as well as fixed some grammar.


```swift
swift run danger-swift command --cwd path/to/working-directory
swift run --package-path path/to/working-directory danger-swift command --cwd path/to/working-directory
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--package-path and --cwd do almost the same thing, but in different ways (so you shouldn't need --cwd if you have --package-path), but --package-path doesn't work in all the cases, it has still some corner cases that needs to be handled, and this is why it is not suggested yet, once it fully supported cwd should be deprecated.

The correct command should be cd path && swift run danger ci --cwd rootFolder

swift run --package-path path/to/working-directory danger-swift command --cwd path/to/working-directory
```

Keep in mind that Danger will automatically search for your Dangerfile in a `danger` directory placed at the root of your project. So if you put your `Dangerfile.swift` and `Package.swift` in a `danger` directory you can leave off the `--cwd` parameter (though, you still have to specify your package path to `swift run`)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use the --dangerfile parameter to specify the Dangerfile you want to run, there is no need to use cwd in that case I think, you can use --package-path and --dangerfile

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO, there is no information about --dangerfile parameter in any reference or documents, and should be written in the README🤔.

@f-meloni
Copy link
Member

Thank you for the PR, just some comments about the --package-path :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants