# github-actions-serverless-pipeline

> A serverless pipeline for GitHub Actions

Latest version **0.0.6** (published 2021-12-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-actions-serverless-pipeline
pnpm add github-actions-serverless-pipeline
yarn add github-actions-serverless-pipeline
bun add github-actions-serverless-pipeline
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2021-12-23 |
| First published | 2021-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 1 |
| Author | Sagar Chauhan |
| Maintainers | sagarchauhan005 |
| Keywords | serverless, github, actions |

## Links

- npm: https://www.npmjs.com/package/github-actions-serverless-pipeline
- Repository: https://github.com/sagarchauhan005/github-actions-serverless-nuxt-ci-cd-pipeline
- Homepage: https://github.com/sagarchauhan005/github-actions-serverless-nuxt-ci-cd-pipeline#readme
- Issues: https://github.com/sagarchauhan005/github-actions-serverless-nuxt-ci-cd-pipeline/issues
- npm.io page: https://npm.io/package/github-actions-serverless-pipeline

## Dependencies (1)

- [gently-copy](https://npm.io/package/gently-copy.md) ^3.2.0

## Recent versions

- 0.0.6 (latest) — 2021-12-23
- 0.0.5 — 2021-12-21
- 0.0.4 — 2021-12-21
- 0.0.3 — 2021-12-20
- 0.0.2 — 2021-12-20
- 0.0.1 — 2021-12-20

## README

# GitHub Actions Serverless CI/CD Pipeline Setup

A simple GitHub actions serverless pipeline setup for a simple serverless function.

# Installation

- Run `npm install github-actions-serverless-pipeline` into your app and then follow the steps.

# Dependency

1. This package expects that all the build procedures or commands are written in a single `Makefile` file and that the `Makefile` is located in the root of the project.
2. A sample file is attached to this package, and you can use it as a template.

# Post Installation Steps

1. Open your `github-actions-setup.yml` from `.github/workflows/` directory.
2. Since this is a hidden folder, make sure it is visible in your editor or file explorer.
3. Replace the following :
    ```
    name: github-actions-setup
    ```
    with
    ```
    name: <your-unique-github-actions-setup-name>
    ```
4. Replace the following :
    ```
    branches: [ master ]
    ```
   with
    ```
    branches: [ <your-branch-name> ]
    ```
5. That's it! Push the changes to your branch, and you are ready to go.

# How to read github-actions-setup.yml file?

#### Check your `github-actions-setup.yml` file in `.github/workflows/` directory to understand what all steps you need to set up.

![Imgur](https://i.imgur.com/VL3MvFR.jpg)

#### Make sure you have added AWS secrets to your specific repository or organization.

![Imgur](https://i.imgur.com/SQlTRZm.jpg)

#### Make sure you have a `make file` in your project root directory which has all the commands to build your project.

![Imgur](https://i.imgur.com/KQVHWUo.jpg)

#### Comment / Uncomment the following snippet if you don't need to install PHP or customize it as per your need. Use this to install any language or package you need.

![Imgur](https://i.imgur.com/bumTO4E.jpg)

#### Comment / Uncomment the following snippet if you don't need any Laravel Mix package to build production assets.

![Imgur](https://i.imgur.com/tE15aO8.jpg)

#### This section sets up the node environment for you to run npm commands.

![Imgur](https://i.imgur.com/Q7kpKI9.jpg)

#### This step allows you to read files at your root directory or local directory such as we use `make` file

![Imgur](https://i.imgur.com/Ksf3sdy.jpg)

# Private package repository in GitHub Actions

1. Generate a new SSH key with sufficient access privileges. For security reasons, don't use your personal SSH key but set up a dedicated one for use in GitHub Actions. See below for a few hints if you are unsure about this step.
2. Make sure you don't have a passphrase set on the private key.
3. Add the public SSH key to the private repository you are pulling from during the Github Action as a 'Deploy Key'.
4. Add the private SSH key to the repository triggering the Github Action:
5. In your repository, go to the Settings > Secrets menu and create a new secret. In this example, we'll call it SSH_PRIVATE_KEY.
6. Put the contents of the private SSH key file into the contents field.
7. This key should start with -----BEGIN ... PRIVATE KEY-----, consist of many lines and ends with -----END ... PRIVATE KEY-----.
8. In your workflow definition file, add the following step. Preferably this would be rather on top, near the actions/checkout@v2 line.

![Imgur](https://i.imgur.com/W476gFj.jpg)

# Customization

You can easily customize the deployment process by adding your own commands to the `Makefile` file.

# Author

[Sagar Chauhan](https://twitter.com/sagarchauhan005) works as a Project Manager - Technology at [Greenhonchos](https://www.greenhonchos.com).
In his spare time, he hunts bug as a Bug Bounty Hunter.
Follow him at [Instagram](https://www.instagram.com/sagarchauhan005/), [Twitter](https://twitter.com/sagarchauhan005),  [Facebook](https://facebook.com/sagar.chauhan3),
[Github](https://github.com/sagarchauhan005)

# License
MIT

---
_Source: https://npm.io/package/github-actions-serverless-pipeline · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._