Skip to content

Commit 25a2b8d

Browse files
DylenTurnbullalessfg
DylenTurnbull
and
alessfg
committed
docs: Update community files
Co-Authored-By: Alessandro Fael Garcia <[email protected]>
1 parent 7ad3697 commit 25a2b8d

17 files changed

+350
-179
lines changed

‎.github/CODEOWNERS

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#####################
2+
# Main global owner #
3+
#####################
4+
5+
*

‎.github/ISSUE_TEMPLATE/bug_report.md

-32
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
name: 🐛 Bug report
3+
description: Create a report to help us improve
4+
labels: bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
Before you continue filling out this report, please take a moment to check that your bug has not been [already reported on GitHub][issue search] 🙌
12+
13+
Remember to redact any sensitive information such as authentication credentials and/or license keys!
14+
15+
**Note:** If you are seeking community support or have a question, please consider starting a new thread via [GitHub discussions][discussions] or the [NGINX Community forum][forum].
16+
17+
[issue search]: ../search?q=is%3Aissue&type=issues
18+
19+
[discussions]: ../discussions
20+
[forum]: https://community.nginx.org
21+
22+
- type: textarea
23+
id: overview
24+
attributes:
25+
label: Bug Overview
26+
description: A clear and concise overview of the bug.
27+
placeholder: When I do "X" with the NGINX unprivileged Docker image, "Y" happens instead of "Z".
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: behavior
33+
attributes:
34+
label: Expected Behavior
35+
description: A clear and concise description of what you expected to happen.
36+
placeholder: When I do "X" with the NGINX unprivileged Docker image, I expect "Z" to happen.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: steps
42+
attributes:
43+
label: Steps to Reproduce the Bug
44+
description: Detail the series of steps required to reproduce the bug. Deploy NGINX Unprivileged Docker image, View output/logs/configuration on '...', See error.
45+
placeholder: When I run the NGINX Docker unprivileged image using [...], the image fails with an error message. If I check the terminal outputs and/or logs, I see the following error info.
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: environment
51+
attributes:
52+
label: Environment Details
53+
description: Please provide details about your environment.
54+
value: |
55+
- Version of Docker and method of installation: [e.g. Docker Desktop / Docker Server]
56+
- Version/tag of the NGINX Docker unprivileged image or specific commit: [e.g. 1.4.3/commit hash]
57+
- Target deployment platform: [e.g. OpenShift/Kubernetes/Docker Compose/local cluster/etc...]
58+
- Target OS: [e.g. RHEL 9/Ubuntu 24.04/etc...]
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: context
64+
attributes:
65+
label: Additional Context
66+
description: Add any other context about the problem here.
67+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this issue in here.

‎.github/ISSUE_TEMPLATE/config.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 💬 Talk to the NGINX community!
5+
url: https://community.nginx.org
6+
about: A community forum for NGINX users, developers, and contributors
7+
- name: 📝 Code of Conduct
8+
url: https://www.contributor-covenant.org/version/2/1/code_of_conduct
9+
about: NGINX follows the Contributor Covenant Code of Conduct to ensure a safe and inclusive community
10+
- name: 💼 For commercial & enterprise users
11+
url: https://www.f5.com/products/nginx
12+
about: F5 offers a wide range of NGINX products for commercial & enterprise users

‎.github/ISSUE_TEMPLATE/feature_request.md

-22
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: ✨ Feature request
3+
description: Suggest an idea for this project
4+
labels: enhancement
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this feature request!
10+
11+
Before you continue filling out this request, please take a moment to check that your feature has not been [already requested on GitHub][issue search] 🙌
12+
13+
**Note:** If you are seeking community support or have a question, please consider starting a new thread via [GitHub discussions][discussions] or the [NGINX Community forum][forum].
14+
15+
[issue search]: ../search?q=is%3Aissue&type=issues
16+
17+
[discussions]: ../discussions
18+
[forum]: https://community.nginx.org
19+
20+
- type: textarea
21+
id: overview
22+
attributes:
23+
label: Feature Overview
24+
description: A clear and concise description of what the feature request is.
25+
placeholder: I would like the NGINX Docker unprivileged image to be able to do "X".
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Detail any potential alternative solutions/workarounds you've used or considered.
34+
placeholder: I have done/might be able to do "X" using the NGINX Docker unprivileged image by doing "Y".
35+
36+
- type: textarea
37+
id: context
38+
attributes:
39+
label: Additional Context
40+
description: Add any other context about the problem here.
41+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this feature request here.

‎.github/ISSUE_TEMPLATE/security_report.md

-27
This file was deleted.

‎.github/ISSUE_TEMPLATE/security_report.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: ⚠️ Security advisory
3+
description: Warn of a security advisory
4+
labels: security
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this security advisory!
10+
11+
Before you continue filling out this request, please take a moment to check that your advisory complies with the guidance in the [security documentation][security] and has not been [already reported on GitHub][issue search] 🙌
12+
13+
**Note:** If you are seeking community support or have a question, please consider starting a new thread via [GitHub discussions][discussions] or the [NGINX Community forum][forum].
14+
15+
[security]: https://github.com/nginx/docker-nginx-unprivileged/blob/main/SECURITY.md
16+
[issue search]: ../search?q=is%3Aissue&type=issues
17+
18+
[discussions]: ../discussions
19+
[forum]: https://community.nginx.org
20+
21+
- type: textarea
22+
id: overview
23+
attributes:
24+
label: Security advisory overview
25+
description: A clear and concise description of what the security advisory is.
26+
placeholder: The NGINX Docker unprivileged image is vulnerable to CVE "X".
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: context
32+
attributes:
33+
label: Additional Context
34+
description: Add any other context about the problem here.
35+
placeholder: Feel free to add any other context/information/screenshots/etc... that you think might be relevant to this security advisory here.

‎.github/pull_request_template.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Describe the use case and detail of the change. If this PR addresses an issue on
66

77
Before creating a PR, run through this checklist and mark each as complete:
88

9-
- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/CONTRIBUTING.md) document
10-
- [ ] I have run `./update.sh` and ensured all entrypoint/Dockerfile template changes have been applied to the relevant image entrypoint scripts & Dockerfiles
11-
- [ ] I have tested that the NGINX Unprivileged Docker images build and run correctly on all supported architectures on an unprivileged environment (check out the [`README`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/README.md) for more details)
12-
- [ ] I have updated any relevant documentation ([`README`](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/README.md))
9+
- [ ] I have read the [contributing guidelines](/CONTRIBUTING.md)
10+
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md)
11+
- [ ] I have run the [`update.sh`](/update.sh) script and ensured all entrypoint/Dockerfile template changes have been applied to the relevant image entrypoint scripts & Dockerfiles
12+
- [ ] I have tested that the NGINX Docker unprivileged image builds and runs correctly on all supported architectures on an unprivileged environment (check out the [`README`](/README.md) for more details)
13+
- [ ] I have updated any relevant documentation ([`README.md`](/README.md))

‎.github/scorecard.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
annotations:
3+
- checks:
4+
- fuzzing
5+
- sast
6+
reasons:
7+
- reason: not-applicable

‎.github/workflows/f5_cla.yml

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: F5 CLA
3+
on:
4+
issue_comment:
5+
types: [created]
6+
pull_request_target:
7+
types: [opened, closed, synchronize]
8+
permissions: read-all
9+
jobs:
10+
f5-cla:
11+
name: F5 CLA
12+
runs-on: ubuntu-24.04
13+
permissions:
14+
actions: write
15+
pull-requests: write
16+
statuses: write
17+
steps:
18+
- name: Run F5 Contributor License Agreement (CLA) assistant
19+
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have hereby read the F5 CLA and agree to its terms') || github.event_name == 'pull_request_target'
20+
uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 # v2.6.1
21+
with:
22+
# Any pull request targeting the following branch will trigger a CLA check.
23+
# NOTE: You might need to edit this value to 'master'.
24+
branch: main
25+
# Path to the CLA document.
26+
path-to-document: https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md
27+
# Custom CLA messages.
28+
custom-notsigned-prcomment: '🎉 Thank you for your contribution! It appears you have not yet signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the [F5 CLA](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md) and reply on a new comment with the following text to agree:'
29+
custom-pr-sign-comment: 'I have hereby read the F5 CLA and agree to its terms'
30+
custom-allsigned-prcomment: '✅ All required contributors have signed the F5 CLA for this PR. Thank you!'
31+
# Remote repository storing CLA signatures.
32+
remote-organization-name: f5
33+
remote-repository-name: f5-cla-data
34+
path-to-signatures: signatures/signatures.json
35+
# Comma separated list of usernames for maintainers or any other individuals who should not be prompted for a CLA.
36+
# NOTE: You will want to edit the usernames to suit your project needs.
37+
allowlist: bot*
38+
# Do not lock PRs after a merge.
39+
lock-pullrequest-aftermerge: false
40+
env:
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42+
PERSONAL_ACCESS_TOKEN: ${{ secrets.F5_CLA_TOKEN }}

‎.github/workflows/ossf_scorecard.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
# This workflow uses actions that are not certified by GitHub. They are provided by a third-party and are governed by separate terms of service, privacy policy, and support documentation.
3+
name: OSSF Scorecard
4+
on:
5+
# For Branch-Protection check. Only the default branch is supported. See https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection.
6+
branch_protection_rule:
7+
# To guarantee Maintained check is occasionally updated. See https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained.
8+
schedule:
9+
- cron: "0 0 * * 1"
10+
push:
11+
branches: [main]
12+
workflow_dispatch:
13+
# Declare default permissions as read only.
14+
permissions: read-all
15+
jobs:
16+
analysis:
17+
name: Scorecard analysis
18+
runs-on: ubuntu-24.04
19+
# Delete the conditional below if you are using the OSSF Scorecard on a private repository.
20+
if: ${{ github.event.repository.private == false }}
21+
permissions:
22+
# Needed if using Code Scanning alerts.
23+
security-events: write
24+
# Needed for GitHub OIDC token if publish_results is true.
25+
id-token: write
26+
steps:
27+
- name: Check out the codebase
28+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
29+
with:
30+
persist-credentials: false
31+
32+
- name: Run analysis
33+
uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
34+
with:
35+
results_file: results.sarif
36+
results_format: sarif
37+
# Publish the results for public repositories to enable scorecard badges. For more details, see https://github.com/ossf/scorecard-action#publishing-results.
38+
publish_results: true
39+
40+
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF format to the repository Actions tab.
41+
- name: Upload artifact
42+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
43+
with:
44+
name: SARIF file
45+
path: results.sarif
46+
retention-days: 5
47+
48+
# Upload the results to GitHub's code scanning dashboard.
49+
- name: Upload SARIF results to code scanning
50+
uses: github/codeql-action/upload-sarif@5f8171a638ada777af81d42b55959a643bb29017 # v3.28.12
51+
with:
52+
sarif_file: results.sarif

‎CODE_OF_CONDUCT.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,19 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
1010

1111
Examples of behavior that contributes to a positive environment for our community include:
1212

13-
- Demonstrating empathy and kindness toward other people
14-
- Being respectful of differing opinions, viewpoints, and experiences
15-
- Giving and gracefully accepting constructive feedback
16-
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17-
- Focusing on what is best not just for us as individuals, but for the overall community
13+
- Demonstrating empathy and kindness toward other people.
14+
- Being respectful of differing opinions, viewpoints, and experiences.
15+
- Giving and gracefully accepting constructive feedback.
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience.
17+
- Focusing on what is best not just for us as individuals, but for the overall community.
1818

1919
Examples of unacceptable behavior include:
2020

21-
- The use of sexualized language or imagery, and sexual attention or advances of
22-
any kind
23-
- Trolling, insulting or derogatory comments, and personal or political attacks
24-
- Public or private harassment
25-
- Publishing others' private information, such as a physical or email address, without their explicit permission
26-
- Other conduct which could reasonably be considered inappropriate in a professional setting
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind.
22+
- Trolling, insulting or derogatory comments, and personal or political attacks.
23+
- Public or private harassment.
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission.
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting.
2726

2827
## Enforcement Responsibilities
2928

0 commit comments

Comments
 (0)