Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Add GitHub issue template #3527

Merged
merged 2 commits into from
Aug 6, 2021
Merged

Add GitHub issue template #3527

merged 2 commits into from
Aug 6, 2021

Conversation

kingdonb
Copy link
Member

@kingdonb kingdonb commented Aug 5, 2021

Based on the issue template from the Flux v2

@hiddeco suggested I make this improvement to reduce the number of questions I need to ask when an issue report is opened, and to stem the tide of folks who might be in the wrong place (meant to report an issue about Flux v2) / still reporting issues about Flux v1 but who are unaware of the maintenance mode status and implications of that with respect to breaking changes or new feature requests and how they can be handled.

Copy link
Member

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preview displays a possible error for me that I think needs to be sorted

There is a problem with this template

YAML error: (): found character that cannot start any token while scanning for the next token at line 50 column 18.

@kingdonb
Copy link
Member Author

kingdonb commented Aug 6, 2021

Thank you, I composed this by hand because I couldn't figure out the UI.

description: "`flux` daemon version, Flux's helm chart version, and/or `fluxctl version`"

This line needed to be quoted, it makes sense that the backtick is not a valid start character for YAML string. I have fixed it and forced pushed over.

@kingdonb
Copy link
Member Author

kingdonb commented Aug 6, 2021

The CI failure was from downloading Helm CLI, which Helm apparently just shut down their Google Storage buckets within the past 48 hours. I cherry-picked a commit from #3530 to resolve it here.

.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug_report.yaml Outdated Show resolved Hide resolved
@hiddeco
Copy link
Member

hiddeco commented Aug 6, 2021

I think the preview page has become more intelligent, as from what I recall, I used an empty string for the assignees as well which did not result in a warning notice.

Kingdon Barrett and others added 2 commits August 6, 2021 12:55
Signed-off-by: Kingdon Barrett <[email protected]>
Co-authored-by: Hidde Beydals <[email protected]>
Signed-off-by: Kingdon Barrett <[email protected]>
@kingdonb
Copy link
Member Author

kingdonb commented Aug 6, 2021

How are you validating/previewing? I think there must be some admin controls on the repo that I don't have.

On the Settings page, my options are very limited. (That's fine though, thanks for your help!)

Copy link
Member

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Template looks good to me, thanks @kingdonb. 💯

@hiddeco
Copy link
Member

hiddeco commented Aug 6, 2021

@kingdonb by viewing the file in rendered mode, e.g. https://github.com/fluxcd/flux/blob/flux-v1-issue-template/.github/ISSUE_TEMPLATE/bug_report.yaml. All issues are resolved now however, and nothing shows anymore.

@kingdonb
Copy link
Member Author

kingdonb commented Aug 6, 2021

Thanks!

@kingdonb kingdonb merged commit 37338c6 into master Aug 6, 2021
@kingdonb kingdonb deleted the flux-v1-issue-template branch August 6, 2021 17:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants