porter-preview-action

This Github action creates a new preview environment in Porter.

Usage

steps:
  - name: Checkout code
    uses: actions/checkout@v2.3.4
  - name: Create Porter preview environment
    uses: porter-dev/porter-preview-action@v0.2.2
    with:
      cluster: 1234
      project: 4321
      token: ${{ secrets.PORTER_TOKEN }}
      namespace: pr-${{ github.event.pull_request.number }}
      pr_id: ${{ github.event.pull_request.number }}
      installation_id: 12344321
      branch: ${{ github.head_ref }}
      action_id: ${{ github.run_id }}

Configuration Options

The possible inputs are:

• token: (string, required): Token for Porter authentication.
• project: (number, required): Project ID of Porter project.
• cluster: (number, required): Cluster ID of Porter cluster.
• namespace: (string, required): Namespace of the application (default "default")
• pr_id: (number, required): The ID of the pull request
• installation_id: (number, required): The installation ID for the Github app which manages preview envs
• branch: (string, required): the branch name of the source branch.
• action_id: the run id for Github actions, should be set automatically.
• host: (string, optional): Host URL of Porter instance. Set this if you use a self-hosted Porter instance.
• file: (string, optional): The path to the porter.yaml file (default "./porter.yaml").