This Github action creates a new preview environment in Porter.
steps:
- name: Checkout code
uses: actions/[email protected]
- name: Create Porter preview environment
uses: porter-dev/[email protected]
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 }}
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 requestinstallation_id
: (number, required): The installation ID for the Github app which manages preview envsbranch
: (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 theporter.yaml
file (default "./porter.yaml").