Skip to content
arrow-up-circle

GitHub Action

Deploy to Neocities using Ruby CLI

v1 Latest version

Deploy to Neocities using Ruby CLI

arrow-up-circle

Deploy to Neocities using Ruby CLI

Deploys a folder to Neocities using its Ruby CLI

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Deploy to Neocities using Ruby CLI

uses: jonchang/deploy-neocities@v1

Learn more about this action in jonchang/deploy-neocities

Choose a version

Deploy to Neocities

An action that deploys a local directory from a workflow to Neocities.

Usage

- name: Deploy to Neocities
  # Don't use master, use a full 40 character commit hash, e.g.,
  # jonchang/deploy-neocities@deadbeef...
  uses: jonchang/deploy-neocities@master
  with:
    # Required, to access Neocities API.
    # https://neocities.org/settings
    # Set in Settings -> Secrets
    key: ${{ secrets.NEOCITIES_API_KEY }}
    # Required, local directory to deploy to Neocities
    dir: _site
    # Optional, if true, delete remote files not present locally
    clean: false

Caveats

  • Can be slow for large sites.

See also