/deploy

A GitHub action to deploy components and styles to a Raisely campaign

Primary LanguageDockerfileOtherNOASSERTION

Raisely Deploy

release Contributor Covenant

A GitHub Action to deploy custom components to a Raisely campaign. Best used in conjunction with the Raisely CLI and local development.

Usage

Use this action within a GitHub repository containing the folder output of the Raisely CLI. Your repository should have a components and stylesheets folder.

To set up this action:

  1. Create a .github/workflows/raisely-deploy.yml file in your GitHub repo.
  2. Add the following code to the raisely-deploy.yml file.
on: push
name: Raisely Deploy Demo
jobs:
  raiselyDeploy:
    name: Raisely Deploy
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Raisely Deploy
      uses: raisely/deploy@v1
      with:
        campaign: ${{ secrets.RAISELY_CAMPAIGN }}
        apikey: ${{ secrets.RAISELY_API_KEY }}

Variables

The Raisely deploy action requires two variables to be passed in as inputs. They are:

campaign: The UUID of the Raisely campaign you'd like to deploy. Note: Components are not scoped per campaign, so will be deployed across your whole Raisely account. apikey: The API key for your Raisely account. You can find this under Settings > API & Webhooks.

License

NoHarm

Contributing

Pull requests are welcome! See CONTRIBUTING.md for more.