Use the `@actions/http-client` and `@actions/github` modules for proxy support #124

JamesMGreene · 2023-02-22T14:32:55Z

Fixes #112
Closes #128
Closes #111
Closes #106

Shout out to @daleyjem / @jeremy-daley-kr for reporting the issue, proposing a PR, discussing approaches, and hopefully also being up for testing this branch out...? 😁🤞🏻🙏🏻

TODO:

Update the unit tests to get them passing
Manual regression testing
- 🔐 See logs for https://github.com/paper-spa/starter-test-gatsby/actions/runs/4350617722/jobs/7601515477

Critical benefit of doing this is inheriting the proxy-honoring behavior from the @actions/http-client and @actions/github libraries

…pi-client

…e from api-client Also remove requestedDeployment field in favor of deploymentInfo.pending

…d one from api-client

…ne from api-client

JamesMGreene · 2023-02-22T14:34:48Z

@jeremy-daley-kr If you could verify the needed proxy support with this branch, that would be amazing! ❤️

        uses: actions/deploy-pages@actions-http-client

src/deployment.js

TooManyBees · 2023-02-22T18:07:10Z

src/deployment.js

          core.info('Reported success!')
          core.setOutput('status', 'succeed')
+          if (this.deploymentInfo) {


this is always truthy, thanks to line 57

So long as the methods are call in the intended order. 😅 Less of a concern for the status check but I picture a future where we invoke cancel() potentially in a post-step if the workflow run fails or is canceled or something that may need to be able to operate without this.deploymentInfo. We're not there today, though, so your point is definitely valid. 👍🏻

…tInfo

jeremy-daley-kr · 2023-02-23T14:43:58Z

@JamesMGreene I'm getting this when I target your branch...

Error: TypeError: octokit.rest.repos.createPagesDeployment is not a function

Update: I think that's what I was seeing when I first tried to go about this method, is that not all functions that have been added to octokit are available yet with the current version of @actions/core, so maybe .request(...) needs to be used in the meantime.

JamesMGreene · 2023-02-24T02:20:53Z

@jeremy-daley-kr Ah, my bad. 🤦🏻‍♂️ I've updated to use octokit.request like you suggested, so please feel free to give it another try when you get a chance.

jeremy-daley-kr · 2023-02-24T19:19:28Z

@JamesMGreene Definitely getting there, but now I've got this:

jeremy-daley-kr · 2023-02-24T23:10:26Z

I think the page itself deployed. Maybe some optional chaining would get me further along to fill you in with more details?

JamesMGreene · 2023-03-02T16:24:05Z

Thanks for the feedback, @jeremy-daley-kr! Sorry it didn't go smoothly. 😖

I'll find some time to do further testing on our side before I ask you to check again. 😅

jeremy-daley-kr · 2023-03-02T23:39:48Z

Thanks for the feedback, @jeremy-daley-kr! Sorry it didn't go smoothly. 😖

I'll find some time to do further testing on our side before I ask you to check again. 😅

No worries, man. I appreciate you sticking with it. I realize it's a bit harder to test if not behind a proxy yourself. If Github had a way of pairing, I'd just as soon do that.

All I need to do at this point is just re-run the failed job since it pulls the latest from your branch, so just let me know.

JamesMGreene · 2023-03-07T04:17:00Z

@jeremy-daley-kr Can you give this another try? I think I've worked out the kinks now. 🤞🏻 😅

tcbyrd

LGTM. Just a few comments, but nothing blocking.

src/deployment.js

src/api-client.js

jeremy-daley-kr · 2023-03-08T18:31:13Z

@jeremy-daley-kr Can you give this another try? I think I've worked out the kinks now. 🤞🏻 😅

All Green on my end! Boom! 🤜💥🤛

jeremy-daley-kr

Excellent work, and thank you!

JamesMGreene · 2023-03-08T18:42:08Z

@jeremy-daley-kr Awwwwwesome! 🎉

I'll work out the last few issues that my teammates have called out and try to get this shipped later today. 🚀

src/api-client.js

…Info

JamesMGreene · 2023-03-09T20:33:34Z

Was able to use this branch to successfully deploy all of our Pages starter workflow regression testing repos. 👍🏻

JamesMGreene · 2023-03-09T20:37:35Z

Published as part of the v1.2.5 release! 🚀

Any of the following uses statements should work:

uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v1.2.5
uses: actions/deploy-pages@497da40f5225e762159b457c9ae5d6f75a136f5c

JamesMGreene added 12 commits February 16, 2023 13:09

Switch dependencies

a7cb42f

Add a module to wrap GitHub REST API and Actions Runtime API requests

93c1fe6

Critical benefit of doing this is inheriting the proxy-honoring behavior from the @actions/http-client and @actions/github libraries

Clarify references to Action ID and Workflow Run ID in logging

20fe504

Swap out the Artifact Exchange interaction for the wrapped one from a…

c291820

…pi-client

Swap out the Pages Deployment creation interaction for the wrapped on…

e7873ec

…e from api-client Also remove requestedDeployment field in favor of deploymentInfo.pending

Move setting 'page_url' output variable to top-level index

12b8ec3

Swap out the Pages Deployment status check interaction for the wrappe…

a0faa04

…d one from api-client

Swap out the Pages Deployment canceling interaction for the wrapped o…

f577a41

…ne from api-client

JS polishing

29db692

Remove axios reference from code

594fd8f

Fix bad references, run the formatter

65f1527

Update distributables

cb00670

JamesMGreene requested a review from a team as a code owner February 22, 2023 14:32

JamesMGreene mentioned this pull request Feb 22, 2023

Add proxy options for Axios calls #111

Closed

TooManyBees reviewed Feb 22, 2023

View reviewed changes

src/deployment.js Outdated Show resolved Hide resolved

TooManyBees reviewed Feb 22, 2023

View reviewed changes

Update Deployment class methods to enforce presence of this.deploymen…

4d06ee6

…tInfo

JamesMGreene added 2 commits February 23, 2023 20:18

Update Octokit usage to use request.js for deployment creation

36aae3e

Update distributables

e47a74e

JamesMGreene added 4 commits March 3, 2023 15:43

Update status handling function for Octokit request

f3ccae1

Update distributables

1947635

Defer looking up RUNTIME_URL until JIT

c8c985c

Tweak verbosity levels

c981f59

JamesMGreene added 7 commits March 6, 2023 22:04

Update distributables

452af0a

Lots of test updates

6f75b99

Update test with module wrapper

93872af

Consolidate before functions

b88aa87

Add test for cancellation

b4ef3c2

Update distributables

973ee9b

Merge branch 'main' into actions-http-client

f2ea9e9

Merge branch 'main' into actions-http-client

4c19579

tcbyrd approved these changes Mar 8, 2023

View reviewed changes

src/deployment.js Outdated Show resolved Hide resolved

src/deployment.js Show resolved Hide resolved

TooManyBees reviewed Mar 8, 2023

View reviewed changes

src/api-client.js Show resolved Hide resolved

jeremy-daley-kr approved these changes Mar 8, 2023

View reviewed changes

JamesMGreene added 3 commits March 8, 2023 19:41

Add some packages for error management

8ca11f2

Update error handling for artifact exchange

54e5e8c

Update distributables

7ee7a04

JamesMGreene commented Mar 9, 2023

View reviewed changes

src/api-client.js Outdated Show resolved Hide resolved

JamesMGreene added 8 commits March 9, 2023 07:49

Extract response processing logic from Artifact Exchange method

360f95f

Update distributables

02bdb05

Make sure we received a deployment response before setting deployment…

f824564

…Info

Update distributables

df61277

Remove redundant safe navigation operators

7e85efa

Update distributables

44b836a

Prefer elevated RequestError#status, if present

a8d1a4c

Update distributables

ce35ecd

JamesMGreene merged commit 497da40 into main Mar 9, 2023

JamesMGreene deleted the actions-http-client branch March 9, 2023 20:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use the `@actions/http-client` and `@actions/github` modules for proxy support #124

Use the `@actions/http-client` and `@actions/github` modules for proxy support #124

Use the @actions/http-client and @actions/github modules for proxy support #124

Use the @actions/http-client and @actions/github modules for proxy support #124

Conversation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Use the `@actions/http-client` and `@actions/github` modules for proxy support #124

Use the `@actions/http-client` and `@actions/github` modules for proxy support #124