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

Add report command #74

Merged
merged 8 commits into from
Mar 16, 2023
Merged

Add report command #74

merged 8 commits into from
Mar 16, 2023

Conversation

ziopio
Copy link
Member

@ziopio ziopio commented Mar 13, 2023

Why

We would like to have an easy way for the user to communicate how to reproduce build/deploy problems with the grisp runtime.

How

Run rebar3 grisp report to generate/copy usefull files. Run with --tar to pack such files.
Execution example:

rebar3 grisp report
...
Grisp report
======================
Written -> /Users/lucasucci/Desktop/grisp/support/_grisp/report/hash.txt
Written -> /Users/lucasucci/Desktop/grisp/support/_grisp/report/build_overlay.txt
Copied -> /Users/lucasucci/Desktop/grisp/support/_grisp/report/rebar.config
Missing -> /Users/lucasucci/Desktop/grisp/support/rebar.lock
----------------------
New report written at /Users/lucasucci/Desktop/grisp/support/_grisp/report.
Absolute paths have been trimmed for privacy.
----------------------
Please make sure no private information is contained in /Users/lucasucci/Desktop/grisp/support/_grisp/report
You can make any change you want and create a new tarball with "--tar"
===> Done

Requires grisp/grisp_tools#19
If the user then later runs with --tar

rebar3 grisp report --tar
Grisp report
======================
Report directory is already present.
----------------------
Created tarball -> /Users/lucasucci/Desktop/grisp/support/_grisp/grisp-report_2023-03-15T16:48:03+01:00.tar.gz
----------------------
Please make sure no private information is contained in /Users/lucasucci/Desktop/grisp/support/_grisp/report
You can make any change you want and create a new tarball with "--tar"
===> Done

Running --tar right away also generates the tarfile

rebar3 grisp report --tar
Grisp report
======================
Written -> /Users/lucasucci/Desktop/grisp/support/_grisp/report/hash.txt
Written -> /Users/lucasucci/Desktop/grisp/support/_grisp/report/build_overlay.txt
Copied -> /Users/lucasucci/Desktop/grisp/support/_grisp/report/rebar.config
Missing -> /Users/lucasucci/Desktop/grisp/support/rebar.lock
----------------------
New report written at /Users/lucasucci/Desktop/grisp/support/_grisp/report.
Absolute paths have been trimmed for privacy.
----------------------
Created tarball -> /Users/lucasucci/Desktop/grisp/support/_grisp/grisp-report_2023-03-15T16:48:37+01:00.tar.gz
----------------------
Please make sure no private information is contained in /Users/lucasucci/Desktop/grisp/support/_grisp/report
You can make any change you want and create a new tarball with "--tar"
===> Done

@ziopio ziopio marked this pull request as ready for review March 15, 2023 08:27
@ziopio
Copy link
Member Author

ziopio commented Mar 15, 2023

@eproxus @GalaxyGorilla
I thought to make everyone happy and let the 2 steps as optional
rebar3 grisp report --tar does everything anyway and user is always warned.
Outputs are in the this PR description

@ziopio ziopio merged commit 2d6ac72 into master Mar 16, 2023
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 this pull request may close these issues.

2 participants