https://github.com/raisely/deploy

A GitHub action to deploy components and styles to a Raisely campaign
https://github.com/raisely/deploy

Last synced: 1 day ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/raisely/deploy
• Owner: raisely
• License: other
• Created: 2022-03-28T04:55:02.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-03-29T13:03:20.000Z (over 2 years ago)
• Last Synced: 2024-04-15T20:24:15.184Z (7 months ago)
• Language: Dockerfile
• Size: 126 KB
• Stars: 0
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Raisely Deploy





A GitHub Action to deploy custom components to a Raisely campaign. Best used in conjunction with the [Raisely CLI](https://github.com/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](LICENSE.md)

## Contributing

Pull requests are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for more.