Inputs

The PullPreview workflow allows various options to be specified in the with section of the workflow:

• admins: Logins of GitHub users that will have their SSH key installed on the instance, comma-separated. Defaults to "@collaborators/push", which means it will automatically allow access to collaborators of the repository who have push permissions. You can also pass a list of GitHub usernames (e.g. "crohr,other-user").

• always_on: By default PullPreview only deploys Pull Requests. With this setting you can also request specific branches to always be deployed. Defaults to none.

• cidrs: The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to the instance. Comma-separated. Defaults to 0.0.0.0/0 (open to everyone).

• compose_files: Compose files to use when running docker-compose up, comma-separated. Defaults to docker-compose.yml.

• dns: Which DNS suffix to use. Defaults to my.pullpreview.com.

• instance_type: Instance type to use. Defaults to small_2_0 (1CPU, 2GB RAM, 10$/month)

• default_port: The port to use when building the preview URL. Defaults to 80.

• ports: Ports to open for external access on the preview server (port 22 is always open). Comma-separated. Defaults to 80/tcp,443/tcp,1000-10000/tcp.

• registries: Names of private registries to authenticate against. E.g. docker://${{ secrets.GHCR_PAT }}@ghcr.io