layerform icon indicating copy to clipboard operation
layerform copied to clipboard

Create a GitHub action to make previews easier

Open lucasfcosta opened this issue 2 years ago • 3 comments

lucasfcosta avatar Aug 27 '23 21:08 lucasfcosta

Hi @lucasfcosta ! Can you please provide more details on this one ?

SaumyaBhushan avatar Sep 09 '23 20:09 SaumyaBhushan

Hi @SaumyaBhushan! Sure, apologies for the lack of detail.

Essentially, we want to make it easier for people to create pull-request previews using Layerform. That means creating a separate GitHub action that we could distribute for them.

That would require automatically configuring the .layerform/config file and making it easier for people to determine which part of Layerform's output is the actual preview link URL which would go into a comment.

Overall, the flow of such a GH action should be something like this:

  • User specifies back-end and provides credentials to S3 bucket through secrets configured on GH
  • User specifies the name of the layer to go up on every pull request
  • User specifies which output path is the link

Then:

  • User opens a PR
  • Layerform runs
  • URL is extracted from output and posted in the PR as a comment

This is a fairly involved task and requires some deep thought into how to design it in a way that's easier for people to use.

Please lmk what you think.

lucasfcosta avatar Sep 10 '23 00:09 lucasfcosta

Thank you for your response @lucasfcosta . Yes, I agree this is a fairly involved task and needs thinking into how to design it.

I am just getting started with this Project and I have worked on GitHub actions before. I will be happy to get involved but will need your support to accomplish this.

SaumyaBhushan avatar Sep 10 '23 05:09 SaumyaBhushan