✅ Ready to clone and code.
This commit is contained in:
parent
9a7680cb96
commit
0cce01b3c7
7 changed files with 13 additions and 79 deletions
4
.github/pull_request_template.md
vendored
4
.github/pull_request_template.md
vendored
|
|
@ -6,7 +6,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on
|
||||||
|
|
||||||
Before creating a PR, run through this checklist and mark each as complete.
|
Before creating a PR, run through this checklist and mark each as complete.
|
||||||
|
|
||||||
- [ ] I have read the [`CONTRIBUTING`](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/CONTRIBUTING.md) document
|
- [ ] I have read the [`CONTRIBUTING`](https://github.com/nginxinc/nginx-otel/blob/main/CONTRIBUTING.md) document
|
||||||
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
|
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works
|
||||||
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
|
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes
|
||||||
- [ ] I have updated any relevant documentation ([`README.md`](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/CHANGELOG.md))
|
- [ ] I have updated any relevant documentation ([`README.md`](https://github.com/nginxinc/nginx-otel/blob/main/README.md) and [`CHANGELOG.md`](https://github.com/nginxinc/nginx-otel/blob/main/CHANGELOG.md))
|
||||||
|
|
|
||||||
29
.github/workflows/rename_project.sh
vendored
29
.github/workflows/rename_project.sh
vendored
|
|
@ -1,29 +0,0 @@
|
||||||
#!/usr/bin/env bash
|
|
||||||
while getopts a:n:u:d: flag
|
|
||||||
do
|
|
||||||
case "${flag}" in
|
|
||||||
a) owner=${OPTARG};;
|
|
||||||
n) name=${OPTARG};;
|
|
||||||
u) url=${OPTARG};;
|
|
||||||
esac
|
|
||||||
done
|
|
||||||
|
|
||||||
echo "Owner: $owner";
|
|
||||||
echo "Repository Name: $name";
|
|
||||||
echo "Repository URL: $url";
|
|
||||||
|
|
||||||
echo "Renaming repository..."
|
|
||||||
|
|
||||||
original_owner="{{REPOSITORY_OWNER}}"
|
|
||||||
original_name="{{REPOSITORY_NAME}}"
|
|
||||||
original_url="{{REPOSITORY_URL}}"
|
|
||||||
for filename in $(git ls-files)
|
|
||||||
do
|
|
||||||
sed -i "s/$original_owner/$owner/g" $filename
|
|
||||||
sed -i "s/$original_name/$name/g" $filename
|
|
||||||
sed -i "s/$original_url/$url/g" $filename
|
|
||||||
echo "Renamed $filename"
|
|
||||||
done
|
|
||||||
|
|
||||||
# This command runs only once on GHA!
|
|
||||||
rm -rf .github/workflows
|
|
||||||
37
.github/workflows/rename_template.yml
vendored
37
.github/workflows/rename_template.yml
vendored
|
|
@ -1,37 +0,0 @@
|
||||||
---
|
|
||||||
name: Rename the template
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
|
|
||||||
permissions: write-all
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
rename-template:
|
|
||||||
if: ${{ !contains(github.repository, 'template') }}
|
|
||||||
runs-on: ubuntu-22.04
|
|
||||||
steps:
|
|
||||||
- name: Check out the codebase
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Set $REPOSITORY_NAME
|
|
||||||
run: echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}' | tr '-' '_' | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
|
|
||||||
shell: bash
|
|
||||||
|
|
||||||
- name: Set $REPOSITORY_URL
|
|
||||||
run: echo "REPOSITORY_URL=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_ENV
|
|
||||||
shell: bash
|
|
||||||
|
|
||||||
- name: Set $REPOSITORY_OWNER
|
|
||||||
run: echo "REPOSITORY_OWNER=$(echo '${{ github.repository }}' | awk -F '/' '{print $1}')" >> $GITHUB_ENV
|
|
||||||
shell: bash
|
|
||||||
|
|
||||||
- name: Rename the project
|
|
||||||
run: |
|
|
||||||
echo "Renaming the project with -a(author) ${{ env.REPOSITORY_OWNER }} -n(name) ${{ env.REPOSITORY_NAME }} -u(urlname) ${{ env.REPOSITORY_URL }}"
|
|
||||||
.github/workflows/rename_project.sh -a ${{ env.REPOSITORY_OWNER }} -n ${{ env.REPOSITORY_NAME }} -u ${{ env.REPOSITORY_URL }}
|
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v4
|
|
||||||
with:
|
|
||||||
commit_message: "✅ Ready to clone and code."
|
|
||||||
push_options: --force
|
|
||||||
|
|
@ -10,11 +10,11 @@ The following is a set of guidelines for contributing to this project. We really
|
||||||
|
|
||||||
[Code Guidelines](#code-guidelines)
|
[Code Guidelines](#code-guidelines)
|
||||||
|
|
||||||
[Code of Conduct](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/CODE_OF_CONDUCT.md)
|
[Code of Conduct](https://github.com/nginxinc/nginx-otel/blob/main/CODE_OF_CONDUCT.md)
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
Follow our [Getting Started Guide](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/README.md#Getting-Started) to get this project up and running.
|
Follow our [Getting Started Guide](https://github.com/nginxinc/nginx-otel/blob/main/README.md#Getting-Started) to get this project up and running.
|
||||||
|
|
||||||
<!-- ### Project Structure (OPTIONAL) -->
|
<!-- ### Project Structure (OPTIONAL) -->
|
||||||
|
|
||||||
|
|
@ -22,18 +22,18 @@ Follow our [Getting Started Guide](https://github.com/{{REPOSITORY_OWNER}}/{{REP
|
||||||
|
|
||||||
### Report a Bug
|
### Report a Bug
|
||||||
|
|
||||||
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/SECURITY.md).**
|
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](https://github.com/nginxinc/nginx-otel/blob/main/SECURITY.md).**
|
||||||
|
|
||||||
### Suggest a Feature or Enhancement
|
### Suggest a Feature or Enhancement
|
||||||
|
|
||||||
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
|
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](https://github.com/nginxinc/nginx-otel/blob/main/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
|
||||||
|
|
||||||
### Open a Pull Request
|
### Open a Pull Request
|
||||||
|
|
||||||
- Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review.
|
- Fork the repo, create a branch, implement your changes, add any relevant tests, submit a PR when your changes are **tested** and ready for review.
|
||||||
- Fill in [our pull request template](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/.github/pull_request_template.md).
|
- Fill in [our pull request template](https://github.com/nginxinc/nginx-otel/blob/main/.github/pull_request_template.md).
|
||||||
|
|
||||||
Note: if you'd like to implement a new feature, please consider creating a [feature request issue](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/.github/feature_request_template.md) first to start a discussion about the feature.
|
Note: if you'd like to implement a new feature, please consider creating a [feature request issue](https://github.com/nginxinc/nginx-otel/blob/main/.github/feature_request_template.md) first to start a discussion about the feature.
|
||||||
|
|
||||||
## Code Guidelines
|
## Code Guidelines
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -30,7 +30,7 @@ This template includes all the scaffolding you need to get started on a standard
|
||||||
|
|
||||||
<!-- DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -- PLACEHOLDER SECTIONS HAVE BEEN INCLUDED FOR YOUR CONVENIENCE -->
|
<!-- DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -- PLACEHOLDER SECTIONS HAVE BEEN INCLUDED FOR YOUR CONVENIENCE -->
|
||||||
|
|
||||||
# {{REPOSITORY_NAME}}
|
# nginx_otel
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|
@ -46,10 +46,10 @@ Maecenas at vehicula justo. Suspendisse posuere elementum elit vel posuere. Etia
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Please see the [contributing guide](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
|
Please see the [contributing guide](https://github.com/nginxinc/nginx-otel/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[Apache License, Version 2.0](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/LICENSE)
|
[Apache License, Version 2.0](https://github.com/nginxinc/nginx-otel/blob/main/LICENSE)
|
||||||
|
|
||||||
© [F5, Inc.](https://www.f5.com/) 2023
|
© [F5, Inc.](https://www.f5.com/) 2023
|
||||||
|
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
## Latest Versions
|
## Latest Versions
|
||||||
|
|
||||||
We advise users to run or update to the most recent release of the {{REPOSITORY_NAME}}. Older versions of the {{REPOSITORY_NAME}} may not have all enhancements and/or bug fixes applied to them.
|
We advise users to run or update to the most recent release of the nginx_otel. Older versions of the nginx_otel may not have all enhancements and/or bug fixes applied to them.
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -30,4 +30,4 @@ Want to get in touch with the NGINX development team directly? Try using the rel
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Please see the [contributing guide](https://github.com/{{REPOSITORY_OWNER}}/{{REPOSITORY_URL}}/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
|
Please see the [contributing guide](https://github.com/nginxinc/nginx-otel/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue