From 34a30f24c188d0ae1b3e36d8d932ee51dd226858 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Wed, 10 Apr 2024 14:10:00 -0500 Subject: [PATCH 1/2] docs: add github issue templates Closes #89 - [x] Issue Templates - [x] bug report - [x] feature request - [x] config linking to discussions and github-ospo issues for overall issue filing - [x] Update README linking to github-ospo repo issues for OSPO GitHub Actions issues as a whole (https://github.com/github/github-ospo/issues/75) - [x] update .env-example to include github app installation auth examples env vars - [x] clean up dependbot.yml Signed-off-by: jmeridth --- .env-example | 5 +++ .github/ISSUE_TEMPLATE/bug_report.yml | 45 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 9 +++++ .github/ISSUE_TEMPLATE/feature_request.yml | 35 +++++++++++++++++ .github/dependabot.yml | 10 +---- README.md | 4 ++ 6 files changed, 100 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.env-example b/.env-example index dfb184d..9ee3a85 100644 --- a/.env-example +++ b/.env-example @@ -1,2 +1,7 @@ GH_TOKEN = " " ORGANIZATION = "organization" + +# GITHUB APP +GH_APP_ID = "" +GH_INSTALLATION_ID = "" +GH_PRIVATE_KEY = "" diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..a0e9642 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,45 @@ +--- +name: Bug report +description: Create a report to help us improve +labels: + - bug +body: + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: To Reproduce + description: Steps to reproduce the behavior + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: textarea + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + validations: + required: false + + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..4d0a208 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +blank_issues_enabled: false + +contact_links: + - name: Ask a question + url: https://github.com/github/evergreen/discussions/new + about: Ask a question or start a discussion + - name: GitHub OSPO GitHub Action Overall Issue + url: https://github.com/github/github-ospo/issues/new + about: File issue for multiple GitHub OSPO GitHub Actions diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..6bfc5a7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,35 @@ +--- +name: Feature request +description: Suggest an idea for this project +labels: + - enhancement +body: + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. Please describe. + placeholder: | + Ex. I'm always frustrated when [...] + validations: + required: false + + - type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: textarea + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: false diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 0782e61..a6d93c1 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,13 +1,7 @@ ---- -# To get started with Dependabot version updates, you'll need to specify which -# package ecosystems to update and where the package manifests are located. -# Please see the documentation for all configuration options: -# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates - version: 2 updates: - - package-ecosystem: "pip" # See documentation for possible values - directory: "/" # Location of package manifests + - package-ecosystem: "pip" + directory: "/" schedule: interval: "daily" - package-ecosystem: "github-actions" diff --git a/README.md b/README.md index e6bc7f9..a30086f 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ This action was developed by the GitHub OSPO for our own use and developed in a If you need support using this project or have questions about it, please [open up an issue in this repository](https://github.com/github/evergreen/issues). Requests made directly to GitHub staff or support team will be redirected here to open an issue. GitHub SLA's and support/services contracts do not apply to this repository. +### OSPO GitHub Actions as a Whole + +All feedback regarding our GitHub Actions, as a whole, should be communicated through [issues on our github-ospo repository](https://github.com/github/github-ospo/issues/new). + ## Use as a GitHub Action 1. Create a repository to host this GitHub Action or select an existing repository. From d72ce6719cf519eb9cf4757bbaa859895b987f86 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Wed, 10 Apr 2024 16:01:03 -0500 Subject: [PATCH 2/2] fix: add yaml triple slashes at top of file Signed-off-by: jmeridth Co-authored-by: Zack Koppert --- .github/dependabot.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index a6d93c1..50ee96a 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,3 +1,4 @@ +--- version: 2 updates: - package-ecosystem: "pip"