-
Notifications
You must be signed in to change notification settings - Fork 81
chore: Update role to latest NGINX best practices #542
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
Merged
Conversation
This file contains hidden or 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates documentation and CI/CD workflows to align with the latest NGINX best practices from the NGINX template repository. Key changes include:
- Revised community support and security reporting details in SUPPORT.md and SECURITY.md.
- Updates to documentation files (README.md, CONTRIBUTING.md, CHANGELOG.md) with corrected links and guidelines.
- Modifications to GitHub workflows and issue/PR templates to reflect updated CLA details and workflow triggers.
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
SUPPORT.md | Updated support instructions and changed references from Slack to forum. |
SECURITY.md | Adjusted vulnerability reporting methods and updated documentation links. |
README.md | Updated CI/CD badges and added OpenSSF Scorecard badge. |
CONTRIBUTING.md | Revised installation guide reference and updated CLA information. |
CHANGELOG.md | Modified changelog note to include required workflow updates. |
.github/workflows/ossf_scorecard.yml | Added push event trigger and updated comments. |
.github/workflows/f5_cla.yml | Updated CLA document URL and clarified branch usage for CLA signatures. |
.github/scorecard.yml | New configuration file for scorecard analysis. |
.github/pull_request_template.md | Corrected CLA link (although the updated link is inconsistent with others). |
.github/ISSUE_TEMPLATE/feature_request.yml | Added new feature request template. |
.github/ISSUE_TEMPLATE/config.yml | Added new issue template configuration. |
.github/ISSUE_TEMPLATE/bug_report.yml | Added new bug report template. |
.github/ISSUE_TEMPLATE/feature_request.md | Removed deprecated template. |
.github/ISSUE_TEMPLATE/bug_report.md | Removed deprecated template. |
Comments suppressed due to low confidence (1)
.github/workflows/f5_cla.yml:32
- [nitpick] The use of the 'branch' parameter for storing CLA signatures may cause confusion with other branch references. Consider renaming or adding a clarifying comment to distinguish its purpose.
branch: main
395634d
to
fcca41e
Compare
fcca41e
to
3cae177
Compare
TasoOneAsia
requested changes
Mar 28, 2025
Co-authored-by: Michael <[email protected]>
Co-authored-by: Michael <[email protected]>
TasoOneAsia
approved these changes
Mar 28, 2025
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.
Proposed changes
Update community docs & required workflows per the latest NGINX template repository guidelines.
Checklist
Before creating a PR, run through this checklist and mark each as complete:
defaults/main/*.yml
,README.md
andCHANGELOG.md
).