Overview
We need to change the Action Items and Resources/Instructions fields in both blank issue forms from value: to placeholder:, because a submitted-unedited form currently produces an issue whose action items literally read "Item 1 / Item 2". A field with a value: is never empty, so the required: true on both fields can never fail — the validation that is supposed to stop a stub issue is decorative.
Action Items
Resources/Instructions
- Files to edit (default branch here is
master, not main):
- At time of writing the
value: keys are at lines 21 and 31 in blank-issue-form.yml and lines 30 and 40 in blank-issue-form-d.yml. Line numbers drift — the reliable way to find them is to search each file for value:; after this change there should be no value: key left in either file.
- GitHub's issue-forms reference on
value vs placeholder: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
- One judgement call worth raising on this issue before doing the Resources field: its current
value: is a link to the DevOps wiki, so today every issue created from these forms carries that link in its body. Converting it to placeholder: means the link stops appearing in submitted issues. If the team wants it to keep appearing, say so here and do only the Action Items half — but note that leaves required: true on Resources still unable to fail.
- Scope is the
devops repo only. devops-security and incubator have the same class of defect on a different field (their Dependency field is prefilled), which is being handled as part of the separate work to converge all three repos on one identical pair of forms. Please do not "fix" those here.
Overview
We need to change the Action Items and Resources/Instructions fields in both blank issue forms from
value:toplaceholder:, because a submitted-unedited form currently produces an issue whose action items literally read "Item 1 / Item 2". A field with avalue:is never empty, so therequired: trueon both fields can never fail — the validation that is supposed to stop a stub issue is decorative.Action Items
.github/ISSUE_TEMPLATE/blank-issue-form.yml, changevalue:toplaceholder:on theaction-itemsfield and on theresources-instructionsfield..github/ISSUE_TEMPLATE/blank-issue-form-d.yml.overviewfield and (in the-dform) thedependency-explanationfield alone — both already useplaceholder:correctly. Four changed lines total, across two files.master, verify: open https://github.com/hackforla/devops/issues/new/choose and start each form in turn. Action Items and Resources/Instructions should render empty with grey hint text. Try submitting with those fields blank and confirm GitHub now blocks it. This step cannot be done from the PR branch — GitHub renders issue forms from the default branch only, so the change is invisible until it merges. Don't close this issue until you have checked both forms.Resources/Instructions
master, notmain):value:keys are at lines 21 and 31 inblank-issue-form.ymland lines 30 and 40 inblank-issue-form-d.yml. Line numbers drift — the reliable way to find them is to search each file forvalue:; after this change there should be novalue:key left in either file.valuevsplaceholder: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schemavalue:is a link to the DevOps wiki, so today every issue created from these forms carries that link in its body. Converting it toplaceholder:means the link stops appearing in submitted issues. If the team wants it to keep appearing, say so here and do only the Action Items half — but note that leavesrequired: trueon Resources still unable to fail.devopsrepo only.devops-securityandincubatorhave the same class of defect on a different field (their Dependency field is prefilled), which is being handled as part of the separate work to converge all three repos on one identical pair of forms. Please do not "fix" those here.