lancaster-university / codal-bootstrap

MIT License
0 stars 1 forks source link

Build tool support to aid issue reporting #4

Open JohnVidler opened 2 years ago

JohnVidler commented 2 years ago

It would be useful for build.py to report the status of all loaded libraries in a succinct way, such that it can be copy/pasted into github issues.

We already have --status but this needs to be revisited to ensure it meets all the requirements for reporting issues... perhaps an enhanced github-centric --info call which would include all current changesets, all current version hashes (inc tags, if on a tagged branch) the current build target and so forth.

Needs discussion as to what would be included here; here is a non-exhaustive list of what I think would be useful right now, but if anyone has any ideas for further inclusion... @microbit-carlos or @finneyj perhaps?

microbit-carlos commented 2 years ago

Sounds good! We can also create a GitHub issue template in the codal repos showing the command to print the info and asking users to paste the results.

I think there is a git command to print the latest tag + number of additional commits since the tag, so that'd be useful to have.

But let's make sure we don't go too overboard, for the vast majority of users this will be a command they'll likely run only to paste the results in a GitHub bug report.

finneyj commented 2 years ago

agree - this sounds great, but let's keep it to the basics. I think your list above looks spot on @JohnVidler