Skip to content

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
merged 3 commits into from
Mar 28, 2025

Conversation

alessfg
Copy link
Member

@alessfg alessfg commented Mar 28, 2025

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:

@Copilot Copilot AI review requested due to automatic review settings March 28, 2025 12:18
@alessfg alessfg self-assigned this Mar 28, 2025
@alessfg alessfg added this to the 0.7.2 milestone Mar 28, 2025
@github-actions github-actions bot added the chore label Mar 28, 2025
@alessfg alessfg added the documentation Improvements or additions to documentation label Mar 28, 2025
@alessfg alessfg requested a review from TasoOneAsia March 28, 2025 12:18
Copy link

@Copilot Copilot AI left a 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

@alessfg alessfg force-pushed the update-best-practices branch 3 times, most recently from 395634d to fcca41e Compare March 28, 2025 14:36
@alessfg alessfg enabled auto-merge March 28, 2025 16:19
@alessfg alessfg force-pushed the update-best-practices branch from fcca41e to 3cae177 Compare March 28, 2025 16:35
@github-project-automation github-project-automation bot moved this from In progress to Review in progress in NGINX Ansible roles & collection Mar 28, 2025
@alessfg alessfg requested a review from TasoOneAsia March 28, 2025 16:57
@alessfg alessfg added this pull request to the merge queue Mar 28, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 28, 2025
@alessfg alessfg added this pull request to the merge queue Mar 28, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 28, 2025
@alessfg alessfg added this pull request to the merge queue Mar 28, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 28, 2025
@alessfg alessfg merged commit a0c7527 into main Mar 28, 2025
14 checks passed
@alessfg alessfg deleted the update-best-practices branch March 28, 2025 19:17
@github-project-automation github-project-automation bot moved this from Review in progress to Done in NGINX Ansible roles & collection Mar 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants