Skip to content
circle

GitHub Action

Fleek Deploy Action

v1.0.2 Latest version

Fleek Deploy Action

circle

Fleek Deploy Action

Deploy Fleek Sites in Github actions

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Fleek Deploy Action

uses: FleekHQ/[email protected]

Learn more about this action in FleekHQ/action-deploy

Choose a version

Deploy Action

Fleek Dev Slack License

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

License

Fleeks Deploy Action is licensed under a GNU General Public License