This repository has been archived by the owner on Apr 5, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update bug report and add feature request templates (#6)
* docs: update bug report template and add config to enable template chooser * build(deps): add @semantic-release/exec package * ci: add composite action to install yq * ci: update the versions of the bug report issue template in release workflow * docs: add feature request issue template
- Loading branch information
1 parent
a4e0aef
commit 8d82130
Showing
10 changed files
with
152 additions
and
22 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: false |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| name: "✨ Feature Request" | ||
| description: Suggest an idea or feature for Algorand Provider | ||
| title: "[Feature]: " | ||
| labels: ["✨ feature"] | ||
| assignees: [] | ||
|
|
||
| body: | ||
| # welcome | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this feature request, all features are welcome and remember, you're awesome! | ||
| - type: textarea | ||
| attributes: | ||
| label: What is your idea or feature suggestion? | ||
| description: Tell us, what idea or feature you suggest to be added to Algorand Provider. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Benefits | ||
| description: Tell us, how this this will be beneficial to Algorand Provider. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| attributes: | ||
| label: Where can we find information about this? | ||
| description: If you are proposing an integration or third-party plugins, please add relevant links and documentation. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: dropdown | ||
| attributes: | ||
| label: Are you willing to provide a PR to address this? | ||
| options: | ||
| - "Yes" | ||
| - "No" |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| name: "Install yq" | ||
|
|
||
| description: "Downloads and installs yq" | ||
|
|
||
| runs: | ||
| using: "composite" | ||
| steps: | ||
| - name: "📦 Install yq" | ||
| run: | | ||
| sudo wget https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -O /usr/bin/yq | ||
| sudo chmod +x /usr/bin/yq | ||
| shell: bash |
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| function set_vars() { | ||
| export ERROR_PREFIX='\033[0;31m[ERROR]\033[0m' | ||
| export INFO_PREFIX='\033[1;33m[INFO]\033[0m' | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| SCRIPT_DIR=$(dirname "${0}") | ||
|
|
||
| source "${SCRIPT_DIR}/set_vars.sh" | ||
|
|
||
| # Public: Adds the latest version to the issue templates. | ||
| # | ||
| # $1 - The version to add. | ||
| # | ||
| # Examples | ||
| # | ||
| # ./bin/update_issue_templates.sh "1.0.0" | ||
| # | ||
| # Returns exit code 0 if successful, or 1 if the semantic version is incorrectly formatted. | ||
| function main { | ||
| local version_included | ||
|
|
||
| set_vars | ||
|
|
||
| if [ -z "${1}" ]; then | ||
| printf "%b no version specified, use: ./bin/update_issue_templates.sh [version] \n" "${ERROR_PREFIX}" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # check the input is in semantic version format | ||
| if [[ ! "${1}" =~ ^[0-9]+\.[0-9]+\.[0-9]+ ]]; then | ||
| printf "%b invalid semantic version, got '${1}', but should be in the format '1.0.0' \n" "${ERROR_PREFIX}" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # printf "%b adding version '%s' to .github/ISSUE_TEMPLATE/bug_report_template.yml \n" "${INFO_PREFIX}" "${1}" | ||
| version_included=$(version="${1}" yq '(.body[] | select(.id == "version") | .attributes.options) | contains([env(version)])' "${PWD}/.github/ISSUE_TEMPLATE/bug_report_template.yml") | ||
|
|
||
| if ! "${version_included}"; then | ||
| printf "%b adding version '%s' to .github/ISSUE_TEMPLATE/bug_report_template.yml \n" "${INFO_PREFIX}" "${1}" | ||
| version="${1}" \ | ||
| yq -i '(.body[] | select(.id == "version") | .attributes.options) = [env(version)] + (.body[] | select(.id == "version") | .attributes.options)' "${PWD}/.github/ISSUE_TEMPLATE/bug_report_template.yml" | ||
| else | ||
| printf "%b version '%s' already added to .github/ISSUE_TEMPLATE/bug_report_template.yml \n" "${INFO_PREFIX}" "${1}" | ||
| fi | ||
|
|
||
| exit 0 | ||
| } | ||
|
|
||
| # And so, it begins... | ||
| main "$1" |
This file contains 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
This file contains 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