instruction to run with newman added #50
Conversation
Signed-off-by: Soham Banerjee <sohambanerjee4abc@hotmail.com>
|
PTAL @coditva @elit-altum |
|
@coditva does this need any changes? |
|
@coditva This is more of a dev-centric usage provided and not about usage of the package. Should we move it to a new CONTRIBUTORS.md ? |
|
@elit-altum I agree, lets move it there and add a link to it in readme. |
That's actually great. I had a suggestion w.r.t reporter. |
README.md
Outdated
| D. Run file with Newman | ||
|
|
||
| ``` | ||
| npm link |
There was a problem hiding this comment.
I think to issue npm link command, you should be in the reporter directory inside newman-dashboard,
cd path/to/newman-dashboard/reporter should be included before npm link command here.
README.md
Outdated
| A. For installation: | ||
|
|
||
| ``` | ||
| npm install -g newman-dashboard |
There was a problem hiding this comment.
We should remove this because we've not published the package. See #51
There was a problem hiding this comment.
Actually source code for reporter is already there.
All we have to do is execute just one more command before this.
npm pack reporter
This will generate a .tgz file, in my case it was newman-reporter-dashboard-0.0.1.tgz
then we can use
npm i -g newman-reporter-dashboard-0.0.1.tgz to install the package.
@soham4abc are you still working on this? Or should I create an issue for creating a new CONTRIBUTORS.md file and work on this?
There was a problem hiding this comment.
I am working on this give me some time
Co-authored-by: RISHABH D TIWARI <rdtiwari.official@gmail.com>
| ``` | ||
| cd /path/to/newman | ||
| npm link | ||
| npm link newman-reporter-dashboard |
There was a problem hiding this comment.
I'm no expert on npm link but I think some modifications are required here.
Give a sec to review this please @coditva .
There was a problem hiding this comment.
You're right. The npm link needs to be executed in the newman-dashboard/reporter directory.
|
The provided information looks good. But any information regarding what has to be done with |
Will the proper documentation be provided to me? |
|
|
||
| newman run -r dashboard collection.json | ||
| ``` | ||
|
|
There was a problem hiding this comment.
We also need to add a section on running and writing tests
There was a problem hiding this comment.
please provide me what needs to be written here
| ``` | ||
| cd /path/to/newman | ||
| npm link | ||
| npm link newman-reporter-dashboard |
There was a problem hiding this comment.
You're right. The npm link needs to be executed in the newman-dashboard/reporter directory.
Co-authored-by: Utkarsh Maheshwari <coditva@gmail.com>
Co-authored-by: Utkarsh Maheshwari <coditva@gmail.com>
Co-authored-by: Utkarsh Maheshwari <coditva@gmail.com>
|
Now @coditva provide me with all the additional sub-parts I need to mention in the docs. And do let me know any more changes are required or not. Thanks! |
|
|
||
| **Step 2:** Clone the forked repository to your local machine with | ||
| ``` | ||
| git clone https://github.com/postmanlabs/newman-dashboard |
There was a problem hiding this comment.
@soham4abc can you just check if https cloning of git repositories is across git versions or specific to some?
There was a problem hiding this comment.
https cloning causes problems in Git versions older than 1.7.10.
Should I add some more documentation to update git to latest version?
Signed-off-by: Soham Banerjee sohambanerjee4abc@hotmail.com
Fixes #26