Skip to content
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

"No response" shows up from issue template responses #59

Closed
illicitonion opened this issue Jun 11, 2023 · 8 comments · Fixed by #117
Closed

"No response" shows up from issue template responses #59

illicitonion opened this issue Jun 11, 2023 · 8 comments · Fixed by #117
Assignees

Comments

@illicitonion
Copy link
Member

Describe the bug

https://cyf-curriculum.netlify.app/fundamentals/sprints/1/backlog/ first exercise has "No response" output from issue template

Screenshot 2023-06-11 at 13 43 01

We should edit out any "No response" sections from GitHub issues. In this instance, I edited it in CodeYourFuture/Course-Fundamentals#8 but it doesn't seem to update on the site. Not sure if there's some caching going on we need to flush...

@SallyMcGrath
Copy link
Member

It will update - the cache is quite long - maybe 24h.

@40thieves
Copy link
Contributor

To me it seems like we should fail the build if we get a bad response from Github? It may not be obvious if or where content is missing in this scenario - and we might not trigger a new build to (potentially) fix it for days/weeks.

However I recognise that might not be possible currently. I assume that throwing an error (or whatever Go's equivalent is) would fail the build? Can this be done from within a template? Would we need to migrate to a Hugo module (I think that's what they're called? I now can't find the relevant docs page 🙄) for this to work?

@illicitonion
Copy link
Member Author

if we get a bad response from Github? It may not be obvious if or where content is missing in this scenario

Just to make sure we're talking about the same thing, the issue isn't that GitHub is failing a request, it's that when someone crated an issue, they did so using a form template, and if you don't answer one of the form template's questions, GitHub still includes the heading for the field, but says No response in the issue.

So content won't be missing, it's just a bit messy/misleading on the page.


We could search for this in responses from GitHub and fail the build to tell the person doing the build "You should go edit the GitHub issue text and try again" - I just made the edit locally to do this, and got the following list of included issues which have _No response_ in their body:

(118 issues)

CodeYourFuture/Induction#1
CodeYourFuture/Induction#2
CodeYourFuture/Module-HTML-CSS#1
CodeYourFuture/Module-HTML-CSS#10
CodeYourFuture/Module-HTML-CSS#11
CodeYourFuture/Module-HTML-CSS#12
CodeYourFuture/Module-HTML-CSS#15
CodeYourFuture/Module-HTML-CSS#16
CodeYourFuture/Module-HTML-CSS#17
CodeYourFuture/Module-HTML-CSS#18
CodeYourFuture/Module-HTML-CSS#19
CodeYourFuture/Module-HTML-CSS#2
CodeYourFuture/Module-HTML-CSS#20
CodeYourFuture/Module-HTML-CSS#21
CodeYourFuture/Module-HTML-CSS#22
CodeYourFuture/Module-HTML-CSS#25
CodeYourFuture/Module-HTML-CSS#26
CodeYourFuture/Module-HTML-CSS#27
CodeYourFuture/Module-HTML-CSS#28
CodeYourFuture/Module-HTML-CSS#29
CodeYourFuture/Module-HTML-CSS#30
CodeYourFuture/Module-HTML-CSS#31
CodeYourFuture/Module-HTML-CSS#5
CodeYourFuture/Module-HTML-CSS#7
CodeYourFuture/Module-HTML-CSS#9
CodeYourFuture/Module-JS1#1
CodeYourFuture/Module-JS1#10
CodeYourFuture/Module-JS1#11
CodeYourFuture/Module-JS1#12
CodeYourFuture/Module-JS1#13
CodeYourFuture/Module-JS1#14
CodeYourFuture/Module-JS1#15
CodeYourFuture/Module-JS1#16
CodeYourFuture/Module-JS1#17
CodeYourFuture/Module-JS1#18
CodeYourFuture/Module-JS1#19
CodeYourFuture/Module-JS1#2
CodeYourFuture/Module-JS1#20
CodeYourFuture/Module-JS1#21
CodeYourFuture/Module-JS1#22
CodeYourFuture/Module-JS1#23
CodeYourFuture/Module-JS1#31
CodeYourFuture/Module-JS1#32
CodeYourFuture/Module-JS1#33
CodeYourFuture/Module-JS1#34
CodeYourFuture/Module-JS1#35
CodeYourFuture/Module-JS1#4
CodeYourFuture/Module-JS1#5
CodeYourFuture/Module-JS1#6
CodeYourFuture/Module-JS1#7
CodeYourFuture/Module-JS1#8
CodeYourFuture/Module-JS1#9
CodeYourFuture/Module-JS2#11
CodeYourFuture/Module-JS2#12
CodeYourFuture/Module-JS2#13
CodeYourFuture/Module-JS2#14
CodeYourFuture/Module-JS2#15
CodeYourFuture/Module-JS2#16
CodeYourFuture/Module-JS2#17
CodeYourFuture/Module-JS2#18
CodeYourFuture/Module-JS2#19
CodeYourFuture/Module-JS2#20
CodeYourFuture/Module-JS2#21
CodeYourFuture/Module-JS2#22
CodeYourFuture/Module-JS2#23
CodeYourFuture/Module-JS2#27
CodeYourFuture/Module-JS2#28
CodeYourFuture/Module-JS2#29
CodeYourFuture/Module-JS2#30
CodeYourFuture/Module-JS2#31
CodeYourFuture/Module-JS2#32
CodeYourFuture/Module-JS2#33
CodeYourFuture/Module-JS2#34
CodeYourFuture/Module-JS2#35
CodeYourFuture/Module-JS2#36
CodeYourFuture/Module-JS2#4
CodeYourFuture/Module-JS2#5
CodeYourFuture/Module-JS2#6
CodeYourFuture/Module-JS2#7
CodeYourFuture/Module-JS2#8
CodeYourFuture/Module-JS2#9
CodeYourFuture/Module-Servers#1
CodeYourFuture/Module-Servers#10
CodeYourFuture/Module-Servers#11
CodeYourFuture/Module-Servers#12
CodeYourFuture/Module-Servers#13
CodeYourFuture/Module-Servers#14
CodeYourFuture/Module-Servers#19
CodeYourFuture/Module-Servers#2
CodeYourFuture/Module-Servers#20
CodeYourFuture/Module-Servers#21
CodeYourFuture/Module-Servers#3
CodeYourFuture/Module-Servers#4
CodeYourFuture/Module-Servers#5
CodeYourFuture/Module-Servers#6
CodeYourFuture/Module-Servers#7
CodeYourFuture/Module-Servers#8
CodeYourFuture/Module-Servers#9
CodeYourFuture/Module-React#1
CodeYourFuture/Module-React#10
CodeYourFuture/Module-React#11
CodeYourFuture/Module-React#12
CodeYourFuture/Module-React#13
CodeYourFuture/Module-React#14
CodeYourFuture/Module-React#15
CodeYourFuture/Module-React#16
CodeYourFuture/Module-React#17
CodeYourFuture/Module-React#18
CodeYourFuture/Module-React#2
CodeYourFuture/Module-React#20
CodeYourFuture/Module-React#21
CodeYourFuture/Module-React#3
CodeYourFuture/Module-React#4
CodeYourFuture/Module-React#5
CodeYourFuture/Module-React#6
CodeYourFuture/Module-React#7
CodeYourFuture/Module-React#8
CodeYourFuture/Module-React#9

I think if we're going to do this, though, we need a plan for avoiding people creating issues with this text, because I suspect we'll easily miss the deployment fail-looping on Netlify because of an issue creation causing problems.

Relatedly... What's our plan to ensure we force re-builds when new issues are filed @SallyMcGrath?

@SallyMcGrath
Copy link
Member

"What's our plan to ensure we force re-builds when new issues are filed @SallyMcGrath?"

repeating conversation here to log it: On rebuilds, actually my general plan was just to build once a day and not worry too much about it. I guess on some level I don't want to build in expectation of instantaneous results. 😂

response: pr from Daniel #90

@SallyMcGrath
Copy link
Member

I think if we're going to do this, though, we need a plan for avoiding people creating issues with this text, because I suspect we'll easily miss the deployment fail-looping on Netlify because of an issue creation causing problems.

Is the answer to this a github action or something? It isn't a Big Deal but I agree it's nicer to not have the no response text.

We could do it post hoc on our side but I think it will be fragile.

@illicitonion
Copy link
Member Author

We could do it post hoc on our side but I think it will be fragile.

I suspect in the short term we should just do this. Fail the nightly build, make sure that notifies a useful group of people, and someone can go do a quick edit and a redeploy.

Things don't actually change that much (after initial creation) that I'd be too worried about the fragility.

If it becomes a real issue / time sink, we can work out how to automate it.

WDYT?

@40thieves
Copy link
Contributor

Just to make sure we're talking about the same thing, the issue isn't that GitHub is failing a request, it's that when someone crated an issue, they did so using a form template, and if you don't answer one of the form template's questions

Ah apologies, I misunderstood.

But it seems that #89 will solve my concern anyway, at least based on my (Go ignorant) read of the code?

Fwiw, I also like Daniel's approach to the No response issue in the PR - presumably folks would check the build before merging. So providing an actionable error message seems like the simplest solution to me.

@illicitonion
Copy link
Member Author

Sounds good - I'll leave this open until I do a blitz of editing the 118 issues and turn the warning into a hard error :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants