Skip to content

github: use envinfo for getting versions in issue reports #245

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 15, 2020
Merged

github: use envinfo for getting versions in issue reports #245

merged 1 commit into from
Oct 15, 2020

Conversation

@agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented Oct 9, 2020

Description

  • replace the version list with a copy+paste this envinfo command,
    copy back the output
  • this should make reporting versions zero-effort and thereby
    significantly decrease non-reporting by making the hard thing easy
    • personally have experienced issues that didn't report but version
      was very relevant to the issue
    • also some folks report "latest" or used carets, which lack posterity
      or are confusing

Tags

Modified, shortened variant of jaredpalmer/tsdx#820

Output Example

It looks like this when running in TSDX for example:

$ npx envinfo --npmPackages typescript,rollup,rollup-plugin-typescript2
npx: installed 1 in 0.951s

  npmPackages:
    rollup: ^1.32.1 => 1.32.1 
    rollup-plugin-typescript2: ^0.26.0 => 0.26.0 
    typescript: ^3.7.3 => 3.7.3

@agilgur5
github: use envinfo for getting versions in issue reports
d492196 
- replace the version list with a copy+paste this envinfo command,
  copy back the output
  - uses a modified, shortened variant of something being used
    successfully downstream in TSDX: jaredpalmer/tsdx@349f299
- this should make reporting versions zero-effort and thereby
  significantly decrease non-reporting by making the hard thing easy
  - personally have experienced issues that didn't report but version
    was very relevant to the issue
  - also some folks report "latest" or used carets, which lack posterity
    or are confusing
@ezolenko ezolenko merged commit fadafef into ezolenko:master Oct 15, 2020
@agilgur5 agilgur5 mentioned this pull request Apr 21, 2022
Merged
@agilgur5 agilgur5 added the scope: github GH-only changes, e.g. issue and PR templates, releases, etc (not docs or CI) label May 7, 2022
Repository owner locked as resolved and limited conversation to collaborators May 7, 2022
@agilgur5 agilgur5 added the kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs label May 26, 2022
@agilgur5 agilgur5 deleted the use-envinfo-in-issue-template branch July 2, 2023 21:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs scope: github GH-only changes, e.g. issue and PR templates, releases, etc (not docs or CI)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@agilgur5 @ezolenko