Add-scanapi-version #4

ShubhamSood1406 · 2020-09-30T20:36:30Z

#3 is solved now and ready to be merged.

camilamaia · 2020-09-30T22:43:09Z

@ShubhamSood1406 for this issue we need to install the scanapi with the corresponding version received from the parameter. I only see the README.md file changed here. Was it by mistake?

ShubhamSood1406 · 2020-10-01T08:33:27Z

@ShubhamSood1406 for this issue we need to install the scanapi with the corresponding version received from the parameter. I only see the README.md file changed here. Was it by mistake?

Can you explain what else to change to fix this issue?

camilamaia · 2020-10-05T00:18:20Z

@ShubhamSood1406 I believe these are the steps to make it work:

Add the new input to actions.yml
https://github.com/scanapi/github-action/blob/master/action.yml#L7
Something like:

inputs:
  scanapi_version:
    description: 'The ScanAPI version to be installed'
    required: false
    default: 'latest'
  arguments:
    ...

Add the new args to actions.yml
https://github.com/scanapi/github-action/blob/master/action.yml#L16

args:
    - ${{ inputs.scanapi_version }}
    - ${{ inputs.arguments }}

Remove ScanAPI installation from Docker file. Which means, remove this line: https://github.com/scanapi/github-action/blob/master/Dockerfile#L9
Install ScanAPI dynamically on entrypoint.sh file, accordingly with the input version. Something similar to this
Update README inputs section with the input scanapi_version info

ShubhamSood1406 · 2020-10-05T14:26:08Z

@camilamaia I updated the files, please review it and tell if I need to change anything else.

camilamaia · 2020-10-08T16:22:39Z

@ShubhamSood1406 thanks for the changes!

Just one caveat here, we need to ensure all the scanapi CLI arguments will be passed too. This commented line was responsible to do it. You still need to pass all the arguments, except the first, which is the version one.

Also, would you mind ppdating the README inputs section with the input scanapi_version info?

ShubhamSood1406 · 2020-10-08T19:09:59Z

@ShubhamSood1406 thanks for the changes!

Just one caveat here, we need to ensure all the scanapi CLI arguments will be passed too. This commented line was responsible to do it. You still need to pass all the arguments, except the first, which is the version one.

Also, would you mind ppdating the README inputs section with the input scanapi_version info?

@camilamaia I updated the file, please check and tell if anything else to change.

ShubhamSood1406 · 2020-10-14T06:47:25Z

@camilamaia Please review this PR to be accepted in Hacktoberfest.

camilamaia

Hey, I left the suggestions in order to make it work.

Here is the example I used to test it:

This was the key to solve it: https://stackoverflow.com/questions/9057387/process-all-arguments-except-the-first-one-in-a-bash-script

camilamaia · 2020-10-15T22:34:41Z

README.md

@@ -17,6 +21,7 @@ The following will take the yaml file and produce a scanapi-report.html file as
 - name: Run automated API tests
  uses: scanapi/github-action@v1
  with:
+    scanapi_version: '==2.0.0'


Suggested change

scanapi_version: '==2.0.0'

scanapi_version: '2.0.0'

Is there a reason for removing this feature?

Everything looks good to me. I would probably add a feature to specify the version in PIP version specifier syntax ('==1.2.3', '~=1.2', etc.) as it was added by @ShubhamSood1406. This would add the capability for users to automatically use the latest version if the patch version is changed and not to update when major updates (with braking changes) occur.

Oh, that makes sense, now I got the point of the way you implemented it on poetry-publish. I agree with you 👍

camilamaia · 2020-10-15T22:48:12Z

README.md

@@ -5,6 +5,10 @@ An action that allows developers to run ScanAPI using github actions.

 ## Inputs

+### `scanapi_version`
+
+Default version of scanapi to install.


Suggested change

Default version of scanapi to install.

The version of ScanAPI to install (default: latest).

entrypoint.sh

camilamaia · 2020-10-15T22:59:00Z

entrypoint.sh

 sh -c "scanapi $*"
+
+if [ $1 != 'latest' ]; then
+  pip install scanapi$1


Suggested change

pip install scanapi$1

pip install "scanapi=="$1

entrypoint.sh

camilamaia · 2020-10-15T23:22:01Z

@JRubics I added you to review this PR since you are the github action expert here! Feel free to suggest any changes :)

entrypoint.sh

ShubhamSood1406 · 2020-10-16T06:29:52Z

Done with the changes according to the suggestions. You can review it. @camilamaia

JRubics · 2020-10-16T17:39:14Z

Everything looks good to me. I would probably add a feature to specify the version in PIP version specifier syntax ('==1.2.3', '~=1.2', etc.) as it was added by @ShubhamSood1406. This would add the capability for users to automatically use the latest version if the patch version is changed and not to update when major updates (with braking changes) occur.

camilamaia

@ShubhamSood1406 I made the suggestions based on what @JRubics proposed. Sorry for the rework, I did not get the idea of the feature before.

camilamaia · 2020-10-16T22:02:47Z

entrypoint.sh

@@ -1,5 +1,9 @@
 #!/bin/bash

-set -e


@ShubhamSood1406 can we have this back?

camilamaia · 2020-10-16T22:03:45Z

README.md

@@ -17,6 +21,7 @@ The following will take the yaml file and produce a scanapi-report.html file as
 - name: Run automated API tests
  uses: scanapi/github-action@v1
  with:
+    scanapi_version: '2.0.0'


Suggested change

scanapi_version: '2.0.0'

scanapi_version: '==2.0.0' # (PIP version specifier syntax)

camilamaia · 2020-10-16T22:04:21Z

entrypoint.sh

@@ -1,5 +1,9 @@
 #!/bin/bash

-set -e
+if [ $1 != 'latest' ]; then
+  pip install "scanapi=="$1


Suggested change

pip install "scanapi=="$1

pip install scanapi$1

ShubhamSood1406 · 2020-10-17T11:51:21Z

@ShubhamSood1406 I made the suggestions based on what @JRubics proposed. Sorry for the rework, I did not get the idea of the feature before.

Done @camilamaia

Add-scanapi-version

88da759

ShubhamSood1406 requested review from a team as code owners September 30, 2020 20:36

Update-ScanAPI-version

1e8f16d

update-version-parameter

899c57a

camilamaia reviewed Oct 15, 2020

View reviewed changes

camilamaia requested a review from JRubics October 15, 2020 23:21

camilamaia reviewed Oct 15, 2020

View reviewed changes

entrypoint.sh Show resolved Hide resolved

ShubhamSood1406 added 2 commits October 16, 2020 11:49

update-API-version

6031420

update-API-version

78ef6b2

camilamaia reviewed Oct 16, 2020

View reviewed changes

update-version-parameter

8ee49e3

camilamaia approved these changes Oct 19, 2020

View reviewed changes

camilamaia merged commit 90d4c50 into scanapi:master Oct 19, 2020

camilamaia mentioned this pull request Oct 19, 2020

Add version parameter #3

Closed

	Default version of scanapi to install.
	The version of ScanAPI to install (default: latest).

	scanapi_version: '2.0.0'
	scanapi_version: '==2.0.0' # (PIP version specifier syntax)

Add-scanapi-version #4

Add-scanapi-version #4

Uh oh!

Conversation

ShubhamSood1406 commented Sep 30, 2020

Uh oh!

camilamaia commented Sep 30, 2020

Uh oh!

ShubhamSood1406 commented Oct 1, 2020

Uh oh!

camilamaia commented Oct 5, 2020

Uh oh!

ShubhamSood1406 commented Oct 5, 2020

Uh oh!

camilamaia commented Oct 8, 2020

Uh oh!

ShubhamSood1406 commented Oct 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ShubhamSood1406 commented Oct 14, 2020

Uh oh!

camilamaia left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

camilamaia commented Oct 15, 2020

Uh oh!

Uh oh!

ShubhamSood1406 commented Oct 16, 2020

Uh oh!

JRubics commented Oct 16, 2020

Uh oh!

camilamaia left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ShubhamSood1406 commented Oct 17, 2020

Uh oh!

Uh oh!

ShubhamSood1406 commented Oct 8, 2020 •

edited

Loading

camilamaia left a comment •

edited

Loading