Compare commits

..

2 Commits

Author SHA1 Message Date
Bret Comnes
5761b44f4d More example comments 2025-02-13 09:50:17 -08:00
Bret Comnes
e062c69fd8 Add a note about settings locations 2025-02-13 09:48:26 -08:00

View File

@@ -32,9 +32,11 @@ jobs:
runs-on: ubuntu-latest
steps:
# The checkout step copies your repo into the action runner. Important!
- uses: actions/checkout@v4
# Set up any tools and build steps here
# This example uses a Node.js toolchain to build a site
# If you don't need Node.js to build your site, you can omit this.
- name: Use Node.js
uses: actions/setup-node@v4
with:
@@ -45,6 +47,7 @@ jobs:
npm i
npm run build
# When the dist_dir is ready, deploy it to neocities
# Here we deploy the folder named `public`
- name: Deploy to neocities
uses: bcomnes/deploy-to-neocities@v3
with:
@@ -66,7 +69,7 @@ You'll need the API token for your site. Go to:
https://neocities.org/settings/{{your-sitename}}#api_key
```
Get your site's API token. In your GitHub repository, set a [secret][sec] called `NEOCITIES_API_TOKEN`. Set the `api_token` input on your `deploy-to-neocities` action to `${{ secrets.NEOCITIES_API_TOKEN }}` as in the example above.
Retreive your site's API token from Neocities. In your GitHub repository, set a [secret][sec] called `NEOCITIES_API_TOKEN`. Set the `api_token` input on your `deploy-to-neocities` action to `${{ secrets.NEOCITIES_API_TOKEN }}` as in the example above. The setting (as of writing) lives in Repository > Settings > Security > Secrets and Variables > Actions > Repository secrets.
During your workflow, generate the files you want to deploy to [Neocities][nc] into a directory. Set this as the `dist_dir` directory in your workflow (the default is `public`). You can use any tools to generate your site that can be installed or brought into the Github actions environment.