Skip to content

feat: Add support for task and execution role ARNs in action.yml and … #293

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

feat: Add support for task and execution role ARNs in action.yml and … #293

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6a9e92f
feat: Add support for task and execution role ARNs in action.yml and …
DMEvanCT Apr 24, 2024
bcab98a
Fix missing semicolon in index.js
DMEvanCT Apr 24, 2024
4051026
Fix task and execution role ARN assignment in index.js
DMEvanCT Apr 24, 2024
240e7ec
Merge branch 'master' into master
DMEvanCT Sep 19, 2024
d26b24f
Merge branch 'master' into master
s3cube Jul 31, 2025
f29f292
Merge branch 'master' into master
DMEvanCT Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ inputs:
command:
description: 'The command used by ECS to start the container image'
required: false
task-role-arn:
description: 'The ARN of the IAM role that the ECS container will assume'
required: false
execution-role-arn:
description: 'The ARN of the IAM role that the ECS task execution role will assume'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This description can be made more explicit, as it could confuse some users since it's self-referencing.
Suggested reword: 'The ARN of the IAM role that the task definition will assume to run the task'

required: false
outputs:
task-definition:
description: 'The path to the rendered task definition file'
Expand Down
12 changes: 12 additions & 0 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ async function run() {
const logConfigurationOptions = core.getInput("log-configuration-options", { required: false });
const dockerLabels = core.getInput('docker-labels', { required: false });
const command = core.getInput('command', { required: false });
const taskRoleArn = core.getInput('task-role-arn', { required: false });
const executionRoleArn = core.getInput('execution-role-arn', { required: false });

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could you remove unnecessary whitespace?


// Parse the task definition
const taskDefPath = path.isAbsolute(taskDefinitionFile) ?
Expand All @@ -38,6 +41,7 @@ async function run() {
}
containerDef.image = imageURI;


Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could you remove unnecessary whitespace?

if (command) {
containerDef.command = command.split(' ')
}
Expand Down Expand Up @@ -121,6 +125,14 @@ async function run() {
})
}

if (taskRoleArn) {
taskDefContents.taskRoleArn = taskRoleArn;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a regex validation for the arn? Need appropriate unit tests as well for these changes.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ECS actually allows name-only format (if the role is in the same account as the task definition), and we rely on that to deploy the same task definition across multiple accounts.

}

if (executionRoleArn) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a regex validation for the arn? Need appropriate unit tests as well for these changes.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ECS actually allows name-only format (if the role is in the same account as the task definition), and we rely on that to deploy the same task definition across multiple accounts.

taskDefContents.executionRoleArn = executionRoleArn;
}

// Write out a new task definition file
var updatedTaskDefFile = tmp.fileSync({
tmpdir: process.env.RUNNER_TEMP,
Expand Down