knight/deploy-to-neocities
1
0
Fork 0
mirror of https://github.com/bcomnes/deploy-to-neocities.git synced 2026-01-16 22:56:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #187 from helenclx/master

Browse Source
This commit is contained in:
Bret Comnes 2024-05-25 13:22:28 -07:00 committed by GitHub
commit bcd01efa4b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -15,7 +15,7 @@ Efficiently deploy a website to [Neocities][nc] using [Github actions](https://g
```yaml ```yaml
name: Deploy to neocities name: Deploy to neocities
# only run on changes to main. Use main or master depending on whatever your default branch is called. # only run on changes to main. Use main or master depending on whatever your default branch is called.
on: on:
push: push:
branches: branches:
@ -72,7 +72,7 @@ You most likely only want to run this on the `master` branch so that only change
### Inputs ### Inputs
- `api_token` (**REQUIRED**): The API token for your [Neocities][nc] website to deploy to. - `api_token` (**REQUIRED**): The API token for your [Neocities][nc] website to deploy to.
- `dist_dir`: The directory to deploy to [Neocities][nc]. Default: `public`. Don't deploy your root repo directory (e.g. `./`). It contains `.git`, `.github` and other files that won't deploy properly to neocities. Keep it clean by keeping or building your site into a subdir and deploy that. - `dist_dir`: The directory to deploy to [Neocities][nc]. Default: `public`. Don't deploy your root repo directory (e.g. `./`). It contains `.git`, `.github` and other files that won't deploy properly to neocities. Keep it clean by keeping or building your site into a subdir and deploy that.
- `cleanup`: Boolean string (`true` or `false`). If `true`, `deploy-to-neocities` will destructively delete files found on [Neocities][nc] not found in your `dist_dir`. Default: `false`. - `cleanup`: Boolean string (`true` or `false`). If `true`, `deploy-to-neocities` will destructively delete files found on [Neocities][nc] not found in your `dist_dir`. Default: `false`.
- `protected_files`: An optional glob string used to mark files as protected. Protected files are never cleaned up. Test this option out with `cleanup` set to false before relying on it. Protected files are printed when `cleanup` is set to true or false. Glob strings are processed by [minimatch](https://github.com/isaacs/minimatch) against remote neocities file paths. Protected files can still be updated. - `protected_files`: An optional glob string used to mark files as protected. Protected files are never cleaned up. Test this option out with `cleanup` set to false before relying on it. Protected files are printed when `cleanup` is set to true or false. Glob strings are processed by [minimatch](https://github.com/isaacs/minimatch) against remote neocities file paths. Protected files can still be updated.
@ -143,6 +143,7 @@ None.
- https://github.com/alephdfilms/neocities/ ([alephd.neocities.org](https://alephd.neocities.org/)] - https://github.com/alephdfilms/neocities/ ([alephd.neocities.org](https://alephd.neocities.org/)]
- https://sacred.neocities.org/ (https://github.com/M-Valentino/sacredOS) - https://sacred.neocities.org/ (https://github.com/M-Valentino/sacredOS)
- https://lenp.net/ (https://github.com/Len42/web-site) - https://lenp.net/ (https://github.com/Len42/web-site)
- https://github.com/helenclx/Neocities-Leilukin (https://leilukin.neocities.org/)
- [See more!](https://github.com/bcomnes/deploy-to-neocities/network/dependents) - [See more!](https://github.com/bcomnes/deploy-to-neocities/network/dependents)
- ...PR your site when you set it up! - ...PR your site when you set it up!