actions-marketplace-validations/Starts a self-hosted EC2 runner on demand

Starts a self-hosted EC2 runner on demand

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
Runtime
Deprecated runtime
namedescriptionrequireddefault
github-tokenGitHub Personal Access Token with the 'repo' scope.yes
subnet-idThe subnet ID that the EC2 instance will be created in. This subnet and security group should be in the same VPC.no
security-group-idEC2 Security Group Id. This subnet and security group should be in the same VPC. The runner itself just needs to be able to make an outbound HTTPS connection. No inbound traffic is needed.no
launch-templateSet 'true' to use the launch template, set 'false' to use image id and explicit configuration parameters. Defaults to false.no
launch-template-idLaunch template id from the EC2 console. Set only if using the launch template approach. Either a template ID or template name is required, but both can't be used at the same time.no
launch-template-nameLaunch template name from the EC2 console. Set only if using the launch template approach. Either a template ID or template name is required, but both can't be used at the same time.no
launch-template-versionLaunch template version to use. Set only if using the launch template approach.no
image-idThe AMI ID to use.no
runner-directoryThe directory in which the runner was installed in. This is the directory where the startup commands will run.yes
regionThe AWS region. Defaults to us-east-1.no
instance-typeEC2 Instance Type. Defaults to t2.micro.no
iam-role-nameIAM Role Name to attach to the created EC2 instance. Note that this requires additional AWS permissions.no
key-nameThe keypair name to attach to the instance. Useful for SSHing into your instance.no
retry-delayThe amount of seconds to wait before re-checking if the instance is registered as a runner yet. The default is to try every 5 seconds, up to 12 times. So we wait 60 seconds in total.no
retry-amountThe number of times to re-check if the instance is registered as a runner yet. The default is to try every 5 seconds, up to 12 times. So we wait 60 seconds in total.no
startup-commandsA list of commands to run on startup. This replaces the default startup commands. You can use these tokens in your commands and they will be replaced: {repoUrl} - The URL of the repo. {name} - The random instance name. {token} - The github runner token. {label} - The random label for the runner.no
ec2-tagsThe tags to attach to the EC2 instance. Note that this requires additional AWS permissions.no
namedescription
runner-labelThe unique label that was assigned to the runner. This is used to reference the runner when running a job on it, and also when removing it from Github.
instance-idEC2 Instance Id of the created runner. The id is used to terminate the EC2 instance when the runner is not needed anymore.