Using Hugo on Gitpod


Create the necessary [Gitpod](https://www.gitpod.io/) files on the root of your repository.

```bash
$ touch .gitpod.Dockerfile
$ touch .gitpod.yml
```

```dockerfile filename=.gitpod.Dockerfile
FROM gitpod/workspace-full

USER root

RUN apt-get update && apt-get install -yq hugo
```

```yaml filename=.gitpod.yml
image:
  file: .gitpod.Dockerfile

tasks:
  - command: 'hugo server --baseUrl $(gp url 1313) --appendPort=false'

ports:
  - port: 1313
    onOpen: open-preview
```

After commiting and merging your code, you can then go to `https://gitpod.io/#https://github.com/<YOUR_USERNAME>/<YOUR_REPO_NAME>` to start your Gitpod workspace.

Optionally, you can also add a Gitpod badge on your `README` file:

```markdown filename=README.md
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/<YOUR_USERNAME>/<YOUR_REPO_NAME>)
```

#### Sources

Setup configuration was copied from [esttech/theia-dev-conf](https://github.com/esttech/theia-dev-conf/).


Deploy Hugo Site Using GitHub Actions


After creating a new project using
[Hugo's Quick Start guide](https://gohugo.io/getting-started/quick-start/), you
can then deploy to [GitHub Pages](https://pages.github.com/).

### Git Branches

For this site, we are deploying the project hosted at
[napjoseph/napjoseph.github.io](https://github.com/napjoseph/napjoseph.github.io/).

Since this is an
[Organization Pages-type repository](https://docs.github.com/en/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites),
we will be using following branches for our workflow:

```bash
$ git branch
master           # the branch that GitHub pages will serve the files from
stable           # the main development branch where all pull requests will be merged to
id_your_feature  # additional development branches for new features
```

### Add your Deploy Key

Follow the tutorial over at
[peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-create-ssh-deploy-key)
and add an SSH deploy key for your project.

### Create your GitHub Action

Afterwards, create a directory for your workflows and add the config file for
your new action.

```bash
$ mkdir -p .github/workflows
$ touch .github/workflows/deploy.yml
```

```yaml filename=.github/workflows/deploy.yml
name: deploy-to-master

on:
  push:
    branches:
      - stable

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2
        with:
          persist-credentials: false

      - name: Update theme
        run: git submodule update --init --recursive

      - name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: '0.74.3'

      - name: Build
        run: HUGO_ENV=production hugo --minify

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
          publish_dir: ./public
          publish_branch: master
          keep_files: false
          allow_empty_commit: true
```

### Deployment

After merging your pull requests to the `stable` branch, it should automatically
deploy to the `master` branch.


Nap Joseph Calub

Posts with the "Hugo" tag