-
Notifications
You must be signed in to change notification settings - Fork 329
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
chore(issues): add new issue templates #253
Open
dkundel
wants to merge
5
commits into
main
Choose a base branch
from
dkundel/improve-issue-templates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
31fcb23
chore(issues): add new issue templates
dkundel 4fc7bc7
ci: auto-update issue template for new templates
dkundel e9437dd
chore(issues): add additional issue templates
dkundel f31195b
lint(helpers): fix lint errors
dkundel 20943a2
chore: fix issue template formatting
dkundel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# THIS FILE IS AUTOGENERATED. Please modify the source in _helpers | ||
name: "Template Bug Report" | ||
description: Report an issue with one of the templates | ||
title: "[Bug]: " | ||
labels: "bug" | ||
body: | ||
- 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: Actual Behavior | ||
description: A clear description of what actually happens. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional Information | ||
description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here. |
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,24 @@ | ||
name: Template Request | ||
description: Request a template for a new or existing use case | ||
title: "[Template Request]: " | ||
labels: template-request | ||
assignees: '' | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: What is your use case? | ||
description: A clear and concise description of what your use case is. | ||
placeholder: SMS Broadcast Notifications | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Describe the solution you'd like. | ||
description: A clear and concise description of what you want to happen. | ||
placeholder: I want a user to be able to input a list of phone numbers and a message into a browser interface. When I click "Send" I want that message to be sent to all of numbers via SMS. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: "Additional requirements/dependencies:" | ||
description: List any additional requirements this template should fulfill. |
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,98 @@ | ||
# THIS FILE IS AUTOGENERATED. Please modify the source in _helpers | ||
name: "Template Bug Report" | ||
description: Report an issue with one of the templates | ||
title: "[Template Bug]: " | ||
labels: "template-bug" | ||
body: | ||
- type: dropdown | ||
attributes: | ||
label: Affected Template | ||
description: Which template is affected by the bug you have found? If multiple are affected please pick "Multiple" and list them in the "Other Comments" section. | ||
options: | ||
- "Blank Template" | ||
- "Hello World" | ||
- "Hello Voice" | ||
- "Hello Messaging" | ||
- "Never gonna give you up" | ||
- "Forward Call" | ||
- "Forward Message" | ||
- "Forward Message to Multiple Numbers" | ||
- "Forward Message to Email via SendGrid" | ||
- "Voicemail" | ||
- "Forward Message to Email via Sparkpost" | ||
- "Airtable SMS Broadcast" | ||
- "Simple Conference" | ||
- "Stripe payments via SMS" | ||
- "Stripe SMS Receipt Webhook Handler Function" | ||
- "Chat Token Function" | ||
- "Sync Token Function" | ||
- "Video Token Function" | ||
- "Hunt / Find Me" | ||
- "HTTP Redirect" | ||
- "Functions Temporary Storage" | ||
- "Phone Verification" | ||
- "Blocklist Call Function" | ||
- "Echo Funlet" | ||
- "Simple Message Funlet" | ||
- "Simple Menu Funlet" | ||
- "Whisper Funlet" | ||
- "Forward Funlet" | ||
- "Call Me Funlet" | ||
- "Simulring Funlet" | ||
- "Find Me Funlet" | ||
- "Voice Client JavaScript Sample Application" | ||
- "conversations" | ||
- "SIP Quickstart" | ||
- "Conference Line with Phone Verification" | ||
- "PIN-protected Conference Line" | ||
- "Caller Gated Conference Line" | ||
- "Basic Video App" | ||
- "SMS Notifications" | ||
- "Voice IVR" | ||
- "Email Verification Magic Links" | ||
- "Verify Testing Dashboard" | ||
- "Verify Push Backend" | ||
- "SMS Broadcast with Verification" | ||
- "International telephone input" | ||
- "Forward SMS message as an email (Mailgun)" | ||
- "JSON Webhook Adapter" | ||
- "SMS Broadcast" | ||
- "Masked Phone Number" | ||
- "COVID-19 Vaccine Standby List" | ||
- "Segment Track Notification" | ||
- "Google Sheets SMS Log" | ||
- "COVID-19 Vaccine FAQ Bot" | ||
- "Patient Appointment Management" | ||
validations: | ||
required: true | ||
- type: dropdown | ||
attributes: | ||
label: Tool Used | ||
description: "How are you using this template? For `twilio-run`/`create-twilio-function` and `twilio serverless` choose `Serverless Toolkit`" | ||
options: | ||
- "CodeExchange Quick Deploy" | ||
- "Serverless Toolkit" | ||
- "Manual (Copy & Paste)" | ||
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: Actual Behavior | ||
description: A clear description of what actually happens. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Browser Version | ||
description: If this is an issue that involves behavior in the browser please specify your browser, version and operating system. | ||
placeholder: "Firefox 89.0.1, macOS Big Sur" | ||
- type: textarea | ||
attributes: | ||
label: Additional Information | ||
description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here. |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
name: Generate Env Manifest | ||
name: Template Updates | ||
|
||
on: | ||
push: | ||
|
@@ -25,6 +25,7 @@ jobs: | |
run: | | ||
npm install | ||
npm run ci:generate-manifest | ||
npm run ci:update-issue-templates | ||
env: | ||
CI: true | ||
NODE_ENV: test | ||
|
@@ -33,11 +34,19 @@ jobs: | |
run: | | ||
git diff --name-only | xargs | ||
echo "::set-output name=files::$(git diff --name-only | xargs)" | ||
- name: commit changes | ||
- name: commit env changes | ||
if: ${{ contains(steps.changes.outputs.files, 'env-variables.manifest.json') }} | ||
run: | | ||
git config user.name twilio-labs-ci | ||
git config user.email [email protected] | ||
git add env-variables.manifest.json | ||
git commit -m "chore(env-manifest): update manifest file" | ||
git push | ||
- name: commit issue template changes | ||
if: ${{ contains(steps.changes.outputs.files, '.github/ISSUE_TEMPLATE/template_bug_report.yml') }} | ||
run: | | ||
git config user.name twilio-labs-ci | ||
git config user.email [email protected] | ||
git add .github/ISSUE_TEMPLATE/template_bug_report.yml | ||
git commit -m "chore(issues): update issue template file" | ||
git push |
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,44 @@ | ||
name: "Template Bug Report" | ||
description: Report an issue with one of the templates | ||
title: "[Template Bug]: " | ||
labels: "template-bug" | ||
body: | ||
- type: dropdown | ||
attributes: | ||
label: Affected Template | ||
description: Which template is affected by the bug you have found? If multiple are affected please pick "Multiple" and list them in the "Other Comments" section. | ||
options: | ||
# <<TEMPLATE_OPTIONS>> | ||
validations: | ||
required: true | ||
- type: dropdown | ||
attributes: | ||
label: Tool Used | ||
description: "How are you using this template? For `twilio-run`/`create-twilio-function` and `twilio serverless` choose `Serverless Toolkit`" | ||
options: | ||
- "CodeExchange Quick Deploy" | ||
- "Serverless Toolkit" | ||
- "Manual (Copy & Paste)" | ||
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: Actual Behavior | ||
description: A clear description of what actually happens. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Browser Version | ||
description: If this is an issue that involves behavior in the browser please specify your browser, version and operating system. | ||
placeholder: "Firefox 89.0.1, macOS Big Sur" | ||
- type: textarea | ||
attributes: | ||
label: Additional Information | ||
description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here. |
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 @@ | ||
const fs = require('fs').promises; | ||
const path = require('path'); | ||
|
||
const OUTPUT_PATH = path.resolve( | ||
__dirname, | ||
'..', | ||
'.github', | ||
'ISSUE_TEMPLATE', | ||
'template_bug_report.yml' | ||
); | ||
const INPUT_PATH = path.resolve(__dirname, 'template_bug_report.yml'); | ||
const TEMPLATES_FILE = path.resolve(__dirname, '..', 'templates.json'); | ||
|
||
async function getTemplateNames() { | ||
const templatesContent = JSON.parse( | ||
await fs.readFile(TEMPLATES_FILE, 'utf8') | ||
); | ||
return templatesContent.templates.map((t) => t.name); | ||
} | ||
|
||
async function run() { | ||
const templates = await getTemplateNames(); | ||
|
||
const optionsList = templates | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Might be an idea to sort the templates so that it's easier to find the one you want to reference. |
||
.map((name) => { | ||
return ` - "${name}"`; | ||
}) | ||
.join('\n'); | ||
|
||
const inputFile = await fs.readFile(INPUT_PATH, 'utf8'); | ||
const outputData = `# THIS FILE IS AUTOGENERATED. Please modify the source in _helpers\n${inputFile.replace( | ||
'# <<TEMPLATE_OPTIONS>>', | ||
optionsList | ||
)}`; | ||
|
||
await fs.writeFile(OUTPUT_PATH, outputData, 'utf8'); | ||
console.log('Issue template updated'); | ||
} | ||
|
||
run().catch(console.error); |
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't requesting templates better handled through the CodeExchange process?