deploy2nekoweb

deploy2nekoweb is a GitHub Action that efficiently deploys your website(s) to nekoweb with ease whenever you make a commit.

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.

usage

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: indiefellas/deploy2nekoweb@main
              with:
                nekoweb-api-key: ${{ secrets.NEKOWEB_API_KEY }}
                nekoweb-domain: 'yoursite.nekoweb.org'
                nekoweb-username: 'yourname'
                directory: 'public'

config

nekoweb-api-key - the API key for your nekoweb account (get it from here)
nekoweb-domain - the nekoweb site you will deploy to (if you have a custom domain like my-awesome-site.com, use that here)
nekoweb-username - your nekoweb username
directory - the directory in your repository that will be deployed to nekoweb

important information!

when using this action, make sure to use the Secrets and variables feature in GitHub to store your API key. this is to prevent any unauthorized access to your account.

how to make a repository secret

1. go to your repository on GitHub
2. click on the Settings tab
3. click on the Secrets and variables dropdown
4. select the Actions button
5. press the New repository secret button
6. profit.