Clarify GitHub App workflow in README #618
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Thank you very much @SpecialThing44! 😄 It is great! Left some minor comments or corrections.
README.md
Outdated
Comment on lines
154
to
159
| ## Configuration | ||
|
|
||
| There is a `repo-config` option in usage which is a path to a configuration file. It defaults to `.github/.scala-steward.conf`. | ||
|
|
||
| See the [configuration documentation](https://github.com/scala-steward-org/scala-steward/blob/main/docs/repo-specific-configuration.md). | ||
|
|
There was a problem hiding this comment.
I believe this is redundant, as it is already specified in the Usage section.
Suggested change
| ## Configuration | |
| There is a `repo-config` option in usage which is a path to a configuration file. It defaults to `.github/.scala-steward.conf`. | |
| See the [configuration documentation](https://github.com/scala-steward-org/scala-steward/blob/main/docs/repo-specific-configuration.md). |
There was a problem hiding this comment.
I don't mind leaving it only in the usage section, but I'm going to add the link in there then, as it is in a separate repo. See latest changes.
SpecialThing44
force-pushed
the
document-github-token
branch
2 times, most recently
from
b7173b9
to
118daa4
Compare
- Remove unclear/inaccurate documentation - Provide more complete example for using the default GitHub Actions App
SpecialThing44
force-pushed
the
document-github-token
branch
from
118daa4
to
1e070dd
Compare
alejandrohdezma
approved these changes
Jul 10, 2024
|
|
A snapshot release has been created as You can test it out with: uses: scala-steward-org/scala-steward-action@snapshots/618It will be automatically recreated on any change to this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To close #617
Prompted by wanting to use this action for a single repository and not wanting to create an app/manage secrets.
See testing https://github.com/SpecialThing44/scala-steward-action-test
Github Actions app does not have permission to write to other repos.
Some other minor clarifications that confused me when I read them.