jubalm / action-deploy

Github Action to deploy code to a Fleek Site

Deploy Action

Introduction

Fleek's Deploy Action provides an easy way to deploy your configured Fleek site's publish directory.

Example Usage

Create a .github/workflows/deploy.yml workflow file in your repository with the following configuration:

on: [push]

jobs:
  test-deploy:
    runs-on: ubuntu-latest
    name: A job to test the action-deploy action by deploying a test site
    steps:
      - uses: actions/checkout@v2
      - name: Deploy test site
        id: deploy
        uses: fleekhq/action-deploy@v1
        with:
          apiKey: ${{ secrets.FLEEK_API_KEY }}
      - name: Get the output url
        run: echo "Deploy url is ${{ steps.deploy.outputs.deployUrl }}"

Configuration Options

The action can be configured with the following input arguments:

• apiKey (required) - Your Fleek scoped API key that has permission to deploy to the configured site.

• workDir (optional) - The location of your .fleek.json config file. Defaults to repositories base directory.

• commitHash - (optional) - Optional git commit hash to deploy. Only useful for fleek sites linked to github.

Contributing

To submit a feature, bug fix, or enhancement to Deploy Actions, follow these steps:

1. Fork this repository.
2. Make desired changes.
3. Confirm a successful Docker build with docker build -t fleekhq/action-deploy ..
4. Open a Pull Request and follow the prompts.

We value and appreciate all contributions.

Related Resources

• Fleek CLI
• Fleek

License

Fleeks Deploy Action is licensed under a GNU General Public License