deploy2nekoweb is a GitHub Action that efficiently deploys your website(s) to nekoweb with ease.
using the power of bun, it's never been more faster to deploy a update out to your site, whether it be a complete redesign, new page, or just fixing a simple typo.
to use this action, you need to create a deploy.yml in the
.github/workflows directory with the following content:
on: [push]
jobs:
test:
runs-on: ubuntu-latest
name: deploy2nekoweb
steps:
- name: Checkout
uses: actions/checkout@v4
# your build step here
- name: deploy2nekoweb
uses: deploy2nekoweb/deploy2nekoweb@v4
with:
nekoweb-api-key: ${{ secrets.NEKOWEB_API_KEY }}
nekoweb-cookie: ${{ secrets.NEKOWEB_COOKIE }}
nekoweb-folder: 'site'
directory: 'public'when using this action, make sure to use the Secrets and variables feature in GitHub to store your API key and cookie. this is to prevent any unauthorized access to your account.
nekoweb-api-key* - the API key for your nekoweb account
nekoweb-cookie - the cookie for your nekoweb account (required for Recently Updated feature) get your cookie here!
nekoweb-folder* - the folder to deploy to on nekoweb
directory* - the directory to deploy to nekoweb
* required
to get your cookie, you need to be logged into nekoweb and open the Developer Tools
and go to the Network tab. then, refresh the page and look for a request
to deploy.nekoweb.org. right click on the request and click on
Copy as cURL (bash) and paste the command below!
important!!! your cookie will update at some point... so if something goes wrong that'd probably the situation.
...
it is recommended to have your site deployed to a folder instead of the root, as it causes problems with the recently updated feature.