README.md

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

• bcomnes/deploy-to-neocities, Node.js action with fancier diffing algorithm
• neocities/neocities-ruby, the Ruby gem this is based on
• A blog post on how to use this Action and a brief explanation for why this exists in the first place