https://github.com/jsumners/gh-action-hugo-deploy

An action to deploy Hugo based sites to GitHub organization repos
https://github.com/jsumners/gh-action-hugo-deploy

actions deployment github-actions publishing

Last synced: 19 days ago
JSON representation

An action to deploy Hugo based sites to GitHub organization repos

• Host: GitHub
• URL: https://github.com/jsumners/gh-action-hugo-deploy
• Owner: jsumners
• Created: 2019-09-14T13:48:47.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-14T20:44:07.000Z (over 5 years ago)
• Last Synced: 2025-01-05T14:38:25.437Z (21 days ago)
• Topics: actions, deployment, github-actions, publishing
• Language: Shell
• Homepage:
• Size: 9.77 KB
• Stars: 8
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

• awesome-repositories - jsumners/gh-action-hugo-deploy - An action to deploy Hugo based sites to GitHub organization repos (Shell)

README

        
# Hugo Deploy Action

This is a simple [GitHub Action](https://github.com/actions) to facilitate

publishing static sites built with [Hugo](https://gohugo.io) to an organization

site. Which is to say:

1. You have a site Hugo project in `foo/site-src` repository.

1. You have a GitHub organization site repository like `foo/foo.github.io`.

1. You want to automated the build and publish process.

## Usage

Add a `.github/workflows/main.yml` file with content like the following:

```yaml

steps:

  - uses: actions/checkout@master

    with:

      submodules: true

  - uses: jsumners/[email protected]

    with:

      destination_repo: foo/foo.github.io

      destination_token: ${{ secrets.Deploy_Token }}

```

Add a [secret][secret] to your `site-src` repository named `Deploy_Token`. The

value of this secret should be a GitHub [access token][token] with the "repo"

permissions. This token must have permission to publish to your `.github.io`

repository.

That's it. See the [`action.yml`](/action.yml) file for more information

on the available configuration options.

[secret]: https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables

[token]: https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line