https://github.com/luisenmarroquin/gh-pages-publish

GitHub Action to publish a folder to GitHub Pages using an SSH key
https://github.com/luisenmarroquin/gh-pages-publish

actions cd ci ci-cd github github-actions javascript js macos marketplace node node-js secrets ssh ssh-key ts typescript ubuntu windows workflow

Last synced: 11 days ago
JSON representation

GitHub Action to publish a folder to GitHub Pages using an SSH key

• Host: GitHub
• URL: https://github.com/luisenmarroquin/gh-pages-publish
• Owner: LuisEnMarroquin
• License: gpl-3.0
• Created: 2020-08-10T22:37:43.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-17T00:10:49.000Z (over 3 years ago)
• Last Synced: 2024-10-31T10:43:30.736Z (16 days ago)
• Topics: actions, cd, ci, ci-cd, github, github-actions, javascript, js, macos, marketplace, node, node-js, secrets, ssh, ssh-key, ts, typescript, ubuntu, windows, workflow
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/github-pages-publish
• Size: 195 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Pages Publish - GitHub Action

[![Fail](https://github.com/LuisEnMarroquin/gh-pages-publish/actions/workflows/windows.yml/badge.svg)](https://github.com/LuisEnMarroquin)

[![Fail](https://github.com/LuisEnMarroquin/gh-pages-publish/actions/workflows/macos.yml/badge.svg)](https://github.com/LuisEnMarroquin)

[![Fail](https://github.com/LuisEnMarroquin/gh-pages-publish/actions/workflows/ubuntu.yml/badge.svg)](https://github.com/LuisEnMarroquin)

This action sends your project build folder to a new/existing branch, example **gh-pages**

## Example usage

```yml

name: Ubuntu

on:

  push:

    branches:

    - main

jobs:

  deploy:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v2

    - uses: LuisEnMarroquin/[email protected]

      with:

        FOLDER: dist

        SSHKEY: ${{ secrets.SSH }}

```

## Inputs

| Key      | Value Information                                                 | Required |

| -------- | ----------------------------------------------------------------- | -------- |

| `BRANCH` | The branch where the project will be deployed, default `gh-pages` | **No**   |

| `FOLDER` | The folder where your files that will be deployed are located     | **Yes**  |

| `SSHKEY` | Your GitHub SSH access key, this comes from GitHub Secrets        | **Yes**  |

Your repo secrets are at: `https://github.com///settings/secrets`

## Outputs

| Key      | Value Information                           |

| -------- | ------------------------------------------- |

| `TIMING` | The time when the action finished execution |