-
Notifications
You must be signed in to change notification settings - Fork 2
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
feat: simplify the input interface #4
Conversation
entrypoint.sh
Outdated
${DOTENV:+--dotenv $DOTENV} | ||
${INSECURE:+--insecure} | ||
${QUIET:+-q} | ||
/home/node/artillery/bin/run "./artillery.report.yml" $1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if I understand this correctly, you're trying to set output to always be the same hardcoded value, right? Aren't you missing the --output
flag then?
Also the artillery report default format is .json
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking about this and decided that it's not a good idea to introduce this implicit behavior for the action alone. The regular run
command doesn't produce any implicit reports, neither should the action. Let the usage be identical, no matter if you're using an action or tapping into the CLI directly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How would a user extract a report from the Github Action though? We might want to showcase this in an example
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean by "extract"?
One of the ways they may want to operate with the generated report is by uploading it as an artifact on the workflow to observe after the run.
- uses: artilleryio/action-cli@v1
with:
command: run test.yml --output report.json
- uses: actions/upload-artifact@v3
with:
name: artillery-report
path: report.json
I believe we have this example in the docs. If we don't, I will add it once we publish the action.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One good point from this is we should add an automated test to ensure the report written in the Docker image is actually available outside of the step 💯 Will add that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a basic test that the generated report exists in the file system. Waiting for it to pass...
Edit: Confirm that the generated report is accessible further into the job! ✅
5a879d0
to
d7b377c
Compare
d7b377c
to
d211504
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This pull request reflects on a larger discussion about the GitHub Action.
Changes
command
input should be used.report
action. I'd not have any implicit behaviors, especially when they deviate from the raw CLI experience. The users can use the--output
flag to generate the report and access it in the file system since they know the path already.README.md
. Directs to the appropriate page in the docs. We shouldn't duplicate these examples, let them live in a single place. Easy to find, easy to manage.