Branch Ruleset Checks #342
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
… suitable for this project
There was a problem hiding this comment.
Copilot reviewed 15 out of 22 changed files in this pull request and generated 1 suggestion.
Files not reviewed (7)
- src/main.js: Evaluated as low risk
- src/functions/help.js: Evaluated as low risk
- src/functions/inputs.js: Evaluated as low risk
- README.md: Evaluated as low risk
- action.yml: Evaluated as low risk
- tests/main.test.js: Evaluated as low risk
- tests/functions/help.test.js: Evaluated as low risk
Tip: Copilot code review supports C#, Go, Java, JavaScript, Markdown, Python, Ruby and TypeScript, with more languages coming soon. Learn more
| @@ -480,6 +480,16 @@ inputs: | |||
| default: | |||
| type: string | |||
| required: false | |||
| use_security_warnings: | |||
| description: | |||
| type: string | |||
There was a problem hiding this comment.
The type for 'description' should be 'boolean' instead of 'string' to match the intended data type.
Suggested change
| type: string | |
| description: | |
| type: boolean |
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
|
Just a quick note about this PR it will break deploy bot on private free accounts with a message like: |
|
Thanks for your prompt resolution @GrantBirki 🙏🏻 |
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.
Branch Ruleset Checks
This pull request introduces non-blocking safety warnings based off your projects branch rulesets. Rulesets are not to be confused with the classic branch protection settings.
Going forward, you should eventually adopt rulesets over branch protects as they are more robust, implement layering, and can be read via the API without requiring admin rights.
This PR introduces a new
use_security_warningssetting that defaults totrue. This setting determines whether this Action should log warning messages related to your ruleset settings. If it discovers potentially dangerous or unsafe configurations, it will be loud and warn you about them. If you don't want these warnings, you may disable them withuse_security_warnings: false.If you leave these warnings on, notice them in your logs, and want to resolve them, you can also do so by viewing the documentation around these warnings here.
Example 📸
This example shows a potential misconfiguration or security issue. The project has a ruleset defined for
mainthat requires pull requests but the total PR reviews required is set to0. This could potentially be an issue as someone could deploy a pull request that has not been approved by other members.📚 References: