https://github.com/keithrozario/github_actions_serverless

A example deployment for Github Actions with Serverless Framework
https://github.com/keithrozario/github_actions_serverless

Last synced: 6 months ago
JSON representation

A example deployment for Github Actions with Serverless Framework

• Host: GitHub
• URL: https://github.com/keithrozario/github_actions_serverless
• Owner: keithrozario
• License: apache-2.0
• Created: 2020-02-27T10:19:44.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T01:29:32.000Z (over 2 years ago)
• Last Synced: 2025-04-12T06:09:18.988Z (6 months ago)
• Language: Python
• Size: 1.04 MB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Github Actions with Serverless Example

A example deployment for Github Actions with Serverless Framework. 

# Installation

* Fork this repo

* Populate `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` in GitHub secrets in your forked repo

![Screenshot](screenshots/AWS_Secrets.png)

# Usage

## Deploy Develop Branch

To create a new environment, create a branch called `develop` and push new code into it.

    $ git checkout -b develop

    $ git commit --allow-empty -m "trigger GitHub actions"

    $ git push --set-upstream origin develop

You can then view the actions being run in the actions tab on your GitHub repository:

By default environments are deployed in `ap-southeast-1`, you can modify this in the serverless.yml file in provider.region.

The standard resources deployed are:

* One hello lambda function (at--hello)

  * With IAM role hello-role-

* One goodbye lambda function (at--goodbye)

  * With IAM role goodbye-role-

* One step function, that chains the two lambd functions together

  * With IAM role at--HelloUnderscoreandUnderscoregoodbyeDash-##random##

* Additional resources like deployment bucket, created by the serverless framework

![Screenshot](screenshots/severless_deploy_develop.png)

## Deploy feature branch

To create a feature branch, and the corresponding environment for it

    $ git checkout -b actions-001

    $ git commit --allow-empty -m "trigger GitHub actions"

    $ git push --set-upstream origin actions-001

And you can see newly created resources in the region of choice, with new 

![Screenshot](screenshots/serverless_deploy_feature_branch.png)

## Delete feature branch

Once a feature branch is merged into develop (or master), you can delete the branch to triggere the removal of that branch's environment.

    $ git push origin --delete actions-001

All corresponding resources in that branch's environment will be permanently deleted.∂

![Screenshot](screenshots/serverless_remove.png)