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

Build tool support to aid issue reporting #4

Open
4 tasks
JohnVidler opened this issue Sep 5, 2022 · 2 comments
Open
4 tasks

Build tool support to aid issue reporting #4

JohnVidler opened this issue Sep 5, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed question Further information is requested

Comments

@JohnVidler
Copy link
Collaborator

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?

  • Current target platform
  • Current git tag or hash for each library
  • Current git tag or hash for the root project
  • The contents of codal.json, for the flags being used
@JohnVidler JohnVidler added enhancement New feature or request help wanted Extra attention is needed question Further information is requested labels Sep 5, 2022
@JohnVidler JohnVidler self-assigned this Sep 5, 2022
@microbit-carlos
Copy link
Collaborator

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
Copy link

finneyj commented Sep 5, 2022

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants