Permissions readme #80
Conversation
There was a problem hiding this comment.
Nice one @Achllle! Thanks a lot for the contribution 😊
I've given some feedback and suggested changes. Please review them when you get a chance 🙌
README.md
Outdated
| @@ -60,6 +64,8 @@ jobs: | |||
| files_to_ignore: '' | |||
| ``` | |||
|
|
|||
| **note**: When using forks and where you don't want any PR to be able to execute code, replace `on: [pull_request]` with `on: [pull_request_target]` (see [GitHub docs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target)). | |||
There was a problem hiding this comment.
Suggestion in order to use GitHub supported alerts:
| **note**: When using forks and where you don't want any PR to be able to execute code, replace `on: [pull_request]` with `on: [pull_request_target]` (see [GitHub docs](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target)). | |
| > [!TIP] | |
| > Replace `on: [pull_request]` with `on: [pull_request_target]` when using forks do not wanting any PR to be able to execute code ([more info](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target)). |
There was a problem hiding this comment.
I should've seen this, thanks. Done manually since your suggestion contained a typo.
README.md
Outdated
| runs-on: ubuntu-latest | ||
| name: Label the PR size | ||
| steps: | ||
| - uses: codelytv/pr-size-labeler@v1 | ||
| - uses: codelytv/pr-size-labeler@v1.10.0 |
There was a problem hiding this comment.
| - uses: codelytv/pr-size-labeler@v1.10.0 | |
| - uses: codelytv/pr-size-labeler@v1 |
Reason why:
You stated that:
With the current v1, some of the features described in the same readme do not work
However, the problem is that we should have updated the v1 tag in order to point it to the most recent v1 release. That is, as far as we continue to respect Semantic Versioning, the new features introduced must not break backward compatibility. So in conclusion, I have changed the commit where the v1 points to in order to have the latest features available without having to specify a particular version.
- Before:
- After:
There was a problem hiding this comment.
Sounds good, I'll revert my commit.
This reverts commit 5f84f9f.
What type of PR is this? (check all applicable)
Description
Notes to Reviewer
I've made some other minor improvements, including specifying the full version in the README's action.yml example. With the current
v1, some of the features described in the same readme do not work. Happy to replace that with a note specifying people should consider using the latest version.Link to issues addressed