feat: GitHub Action to manage Review Apps on Heroku #1

RyanGWU82 · 2022-05-10T00:02:31Z

This is a GitHub Action that can be used as an alternative to Heroku Review Apps! It manages the full lifecycle of a review app:

When a Pull Request is opened or reopened, a review app is created in the given Heroku pipeline
When a Pull Request is synchronized, the review app is rebuilt with the latest source
When a Pull Request is closed, the review app is deleted

There's more documentation in the README.md file, so I'd start there.

I created this by starting with the review app tool I had built for readme (https://github.com/readmeio/readme/pull/6616) and modifying it to work as a GitHub action. As a result most of the code in src/heroku.js, src/netrc.js, and src/git.js is copied over from that script, along with the tests for those files.

Note that the node_modules directory needs to be checked into this repo, so that the GitHub Action can run without a separate install step. I've committed that directly to main so that it doesn't show up in this PR.

Also note that this repo is public so please don't post anything proprietary in your PR comments!

RyanGWU82 · 2022-05-10T21:32:09Z

src/comments.js

+  }
+  return result;
+}
+


RyanGWU82 · 2022-05-10T21:32:23Z

src/comments.js

+  });
+  return postComment(comment);
+};
+


RyanGWU82 · 2022-05-10T21:32:40Z

src/comments.js

+  });
+  return postComment(comment);
+};
+


Very very nice.

kanadgupta · 2022-05-11T16:34:50Z

A couple of overarching questions before I dive into a proper review:

It looks like linting + tests aren't being run, is that on your radar? Maybe we can just run those via GitHub Action?
I'm generally hesitant about tracking node_modules via git, it was a big pain point with our old GitHub Action. I know that the GitHub Actions docs recommend using @vercel/ncc to build a dist and tracking that instead, have you looked into that? I've used that approach in one of my personal projects and I've been very happy with that approach!

RyanGWU82 · 2022-05-11T16:45:53Z

Hi @kanadgupta:

I just added a CircleCI workflow. 😄
I tried ncc before and it just doesn't seem to work at all. I tried again just now and captured the exact output, any ideas what's up here? (There's definitely a package.json in /Users/ryan/readmeio/heroku-review-app-action)

# Run ncc like they suggest
$ ncc build index.js 
-bash: ncc: command not found

# OK, run ncc with npx
$ npx ncc build index.js 
ncc: Version 0.33.4
ncc: Compiling file index.js into CJS
9kB  dist/index.js
9kB  [280ms] - ncc 0.33.4

# Hmmm, 9 KB with all these dependencies? 🤔 
# Let's try running the script anyway to see what happens...
$ node dist/index.js 
/Users/ryan/readmeio/heroku-review-app-action/dist/index.js:194
    throw new Error('Unable to find package.json in any of:\n[' + pathString + ']')
    ^

Error: Unable to find package.json in any of:
[/Users/ryan/readmeio,
/Users/ryan/readmeio/heroku-review-app-action]
    at init (/Users/ryan/readmeio/heroku-review-app-action/dist/index.js:194:11)
    at Object.814 (/Users/ryan/readmeio/heroku-review-app-action/dist/index.js:242:25)
    at __nccwpck_require__ (/Users/ryan/readmeio/heroku-review-app-action/dist/index.js:301:42)
    at /Users/ryan/readmeio/heroku-review-app-action/dist/index.js:332:1
    at /Users/ryan/readmeio/heroku-review-app-action/dist/index.js:338:3
    at Object.<anonymous> (/Users/ryan/readmeio/heroku-review-app-action/dist/index.js:341:12)
    at Module._compile (node:internal/modules/cjs/loader:1103:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1157:10)
    at Module.load (node:internal/modules/cjs/loader:981:32)
    at Function.Module._load (node:internal/modules/cjs/loader:822:12)

RyanGWU82 · 2022-05-11T16:49:29Z

Ah, the ncc issue is ilearnio/module-alias#81 because I'm using module-alias… unfortunately they've marked module-alias as a known incompatibility.

Let me see if I can get things to run properly without module-alias...

.circleci/config.yml

dok

LGTM

dok · 2022-05-11T17:09:49Z

src/comments.js

+  });
+  return postComment(comment);
+};
+


Very very nice.

src/heroku.js

src/netrc.js

RyanGWU82 · 2022-05-11T17:33:21Z

@kanadgupta OK, I've got ncc working so that we don't have to version our node_modules. Thanks for pushing back on that, this is much cleaner!

…HTTPS URL

RyanGWU82 · 2022-05-11T18:07:12Z

With 1 approval I'm going to merge this so that I can start adding the action to our repos, but I'd encourage everyone to keep reviewing this and comment if you have any questions or feedback. 🙇🏼

RyanGWU82 force-pushed the dev branch 5 times, most recently from 5c093fb to 54c7dce Compare May 10, 2022 21:25

RyanGWU82 requested review from dok, ellierossuck, erunion, gratcliff, kanadgupta and rafegoldberg May 10, 2022 21:26

RyanGWU82 commented May 10, 2022

View reviewed changes

src/comments.js

}

return result;

}

Copy link

Contributor Author

RyanGWU82 May 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RyanGWU82 commented May 10, 2022

View reviewed changes

src/comments.js

});

return postComment(comment);

};

Copy link

Contributor Author

RyanGWU82 May 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RyanGWU82 commented May 10, 2022

View reviewed changes

RyanGWU82 marked this pull request as ready for review May 10, 2022 21:33

RyanGWU82 force-pushed the dev branch from aac1723 to 1477c35 Compare May 11, 2022 16:42

dok reviewed May 11, 2022

View reviewed changes

.circleci/config.yml Show resolved Hide resolved

RyanGWU82 force-pushed the main branch from 0936225 to 8c09540 Compare May 11, 2022 17:07

Ryan Park added 2 commits May 11, 2022 10:07

feat: GitHub Action to manage Review Apps on Heroku

08e541d

chore: CircleCI linter and unit tests

0558e54

dok approved these changes May 11, 2022

View reviewed changes

RyanGWU82 force-pushed the dev branch 2 times, most recently from 51be945 to fd23e06 Compare May 11, 2022 17:32

chore: use vercel instead of versioning node_modules

a2a603c

RyanGWU82 force-pushed the dev branch from fd23e06 to a2a603c Compare May 11, 2022 17:33

refactor: stop using .netrc file, instead include credentials in the …

191e9ce

…HTTPS URL

RyanGWU82 merged commit 583d24d into main May 11, 2022

RyanGWU82 deleted the dev branch May 11, 2022 18:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: GitHub Action to manage Review Apps on Heroku #1

feat: GitHub Action to manage Review Apps on Heroku #1

RyanGWU82 commented May 10, 2022 •

edited

Loading

RyanGWU82 May 10, 2022

RyanGWU82 May 10, 2022

RyanGWU82 May 10, 2022

dok May 11, 2022

kanadgupta commented May 11, 2022

RyanGWU82 commented May 11, 2022

RyanGWU82 commented May 11, 2022

dok left a comment

dok May 11, 2022

RyanGWU82 commented May 11, 2022

RyanGWU82 commented May 11, 2022

feat: GitHub Action to manage Review Apps on Heroku #1

feat: GitHub Action to manage Review Apps on Heroku #1

Conversation

RyanGWU82 commented May 10, 2022 • edited Loading

RyanGWU82 May 10, 2022

Choose a reason for hiding this comment

RyanGWU82 May 10, 2022

Choose a reason for hiding this comment

RyanGWU82 May 10, 2022

Choose a reason for hiding this comment

dok May 11, 2022

Choose a reason for hiding this comment

kanadgupta commented May 11, 2022

RyanGWU82 commented May 11, 2022

RyanGWU82 commented May 11, 2022

dok left a comment

Choose a reason for hiding this comment

dok May 11, 2022

Choose a reason for hiding this comment

RyanGWU82 commented May 11, 2022

RyanGWU82 commented May 11, 2022

RyanGWU82 commented May 10, 2022 •

edited

Loading