Static commandView documentation at command
Optional args: string[]Static getView documentation at getEnvironmentVariable
Static getView documentation at getInput
Optional inputVar: stringStatic getView documentation at getMultiLineInput
Optional inputVar: stringStatic setView documentation at setOutput
Generated using TypeDoc
Utility class wrapping core methods.
Static command
+
+ View documentation at command
+
Optional args: string[]
+ Static get
+ View documentation at
+ getEnvironmentVariable
+
Static get
+ View documentation at getInput
+
Optional inputVar: stringStatic get
+ View documentation at getMultiLineInput
+
Optional inputVar: stringStatic set
+ View documentation at setOutput
+
Generated using TypeDoc
+Use the RunSummaries construct to set custom summary messages during the execution of actions that will be surfaced on the workflows UI.
-Static runStatic addStatic addStatic clearStatic Private truncateGenerated using TypeDoc
+ Use the RunSummaries construct to set custom summary messages during the execution of actions that will be surfaced on the workflows UI. +
+Static runStatic addStatic addStatic clearStatic Private truncate
+ Generated using TypeDoc
+An enumeration that represents the types of messages such as error, information, or warnings. -Currently, only error messages being surfaced are supported.
-Generated using TypeDoc
+ An enumeration that represents the types of messages such as error, information, or warnings. Currently, only error messages being + surfaced are supported. +
+Generated using TypeDoc
+Generated using TypeDoc
Generated using TypeDoc
+Executes the command on the runtime. -Both command and its argument are sanitized (escaped) before execution.
+ + + + + +Executes the command on the runtime. Both command and its argument are sanitized (escaped) before execution.
-Command Output: The complex object with runtime execution parameters.
The command to execute.
-If true, all the input is sanitized.
-(since v1.0.13) If true, standard input will be disabled for the command.
-Optional args: string[]The command arguments.
-Generated using TypeDoc
+ Command Output: The complex object with runtime execution parameters.
+
The command to execute.
If true, all the input is sanitized.
(since v1.0.13) If true, standard input will be disabled for the command.
Optional args: string[]
+ The command arguments.
Generated using TypeDoc
+Provides the value of the environment variable as setup in the workflow definition and runtime environment. -Limits the value to a single line.
+ + + + + ++ Provides the value of the environment variable as setup in the workflow definition and runtime environment. Limits the value to a + single line. +
-The value of the environment variable. Limits to a single line.
-The name of the environment variable. The value is sanitized by escaping special characters.
-Generated using TypeDoc
The value of the environment variable. Limits to a single line.
+The name of the environment variable. The value is sanitized by escaping special characters.
+Generated using TypeDoc
+Provides the value of the action parameter as setup on the workflow definition. -Limits the value to a single line.
+ + + + + +Provides the value of the action parameter as setup on the workflow definition. Limits the value to a single line.
-The value of the resolved input variable as setup in the workflow definition.
-The name of the environment variable. The value is sanitized by escaping special characters.
-Generated using TypeDoc
The value of the resolved input variable as setup in the workflow definition.
+The name of the environment variable. The value is sanitized by escaping special characters.
+Generated using TypeDoc
+Generated using TypeDoc
+Provides the multi-line value of the action parameter as setup on the workflow definition.
+ + + + + +Provides the multi-line value of the action parameter as setup on the workflow definition.
-The multi-line value of the resolved input variable as setup in the workflow definition.
-The name of the environment variable. The value is sanitized by escaping special characters.
-Generated using TypeDoc
The multi-line value of the resolved input variable as setup in the workflow definition.
+The name of the environment variable. The value is sanitized by escaping special characters.
+Generated using TypeDoc
+Optional args: string[]
+ Generated using TypeDoc
+Generated using TypeDoc
Generated using TypeDoc
+Generated using TypeDoc
+Sets the output value for the action output parameter.
+ + + + + +Sets the output value for the action output parameter.
-The result of running echo ${varName}.
The name of the environment variable. The variable must match the ^[A-Za-z0-9][A-Za-z0-9-_]{1,30}[A-Za-z0-9]$ pattern.
-The fully resolved value of the output variable.
-Generated using TypeDoc
The result of running echo ${varName}.
The name of the environment variable. The variable must match the ^[A-Za-z0-9@-_]+$ pattern.
+The fully resolved value of the output variable.
Generated using TypeDoc
+Generated using TypeDoc
+Generated using TypeDoc
+Parses action.yaml file into a model and sanitizes user input by HTML escaping special characters.
+ + + + + +Parses action.yaml file into a model and sanitizes user input by HTML escaping special characters.
-Action model The model populated from the file's content.
The file name to be parsed. This file must be in the YAML format.
-Generated using TypeDoc
+ Action model The model populated from the
+ file's content.
+
The file name to be parsed. This file must be in the YAML format.
Generated using TypeDoc
+Copies from source to a destination file. Overrides the destination file if it exists and override flag is set to true.
-The source file.
-The destination file.
-Optional overrideDest: booleanOverride destination file if it already exists.
-Generated using TypeDoc
Copies from source to a destination file. Overrides the destination file if it exists and override flag is set to true.
+The source file.
The destination file.
Optional overrideDest: booleanOverride destination file if it already exists.
Generated using TypeDoc
+Sanitizes (escapes) special characters in the input.
+ + + + + +Generated using TypeDoc
The sanitized and input or empty string if the input is undefined.
+Optional input: stringThe input to be sanitized.
Generated using TypeDoc
+Checks if the input is a string.
+ + + + + +Generated using TypeDoc
Returns true if the given input is a string.
+The input to be checked.
Generated using TypeDoc
+Validates if the output variable name is valid by checking against this pattern - https://github.com/aws/actions-dev-kit/blob/main/packages/adk/templates/codecatalyst_model_schema.json#L94
-The destination file.
-Generated using TypeDoc
+ Validates if the output variable name is valid by checking against this pattern - + https://github.com/aws/actions-dev-kit/blob/main/packages/adk/templates/codecatalyst_model_schema.json#L94 +
+The destination file.
Generated using TypeDoc
+Sanitizes (escapes) special characters in the command and its arguments.
+ + + + + +Sanitizes (escapes) special characters in the command and its arguments.
-The sanitized and concatenated command with arguments.
-The command to be sanitized.
-If true, all the input is sanitized.
-Optional args: string[]The command arguments to be sanitized.
-Generated using TypeDoc
The sanitized and concatenated command with arguments.
+The command to be sanitized.
If true, all the input is sanitized.
Optional args: string[]
+ The command arguments to be sanitized.
Generated using TypeDoc
+Checks if the input is a boolean.
+ + + + + +Generated using TypeDoc
Returns the input as a boolean or undefined.
+The input to be checked.
Generated using TypeDoc
+Checks if the input is a string.
+ + + + + +Generated using TypeDoc
Returns the input as a string or undefined.
+The input to be checked.
Generated using TypeDoc
+Writes content to a destination file. Overrides the destination file if it exists and override flag is set to true.
-The destination file.
-The content to be written.
-Optional overrideDest: booleanOverride destination file if it already exists.
-Generated using TypeDoc
Writes content to a destination file. Overrides the destination file if it exists and override flag is set to true.
+The destination file.
The content to be written.
Optional overrideDest: booleanOverride destination file if it already exists.
Generated using TypeDoc
+Generated using TypeDoc
+Generated using TypeDoc
+Amazon CodeCatalyst provides software development teams one place to plan work, collaborate on code, and build, test, and deploy applications with continuous integration/continuous delivery (CI/CD) tools. For more information, see What is Amazon CodeCatalyst?
-With the CodeCatalyst Action Development Kit (ADK), you can build, test, and publish actions to the CodeCatalyst actions catalog, where other users can add them to workflows. This ADK provides tooling and support to help you develop actions using libraries and frameworks.
-In CodeCatalyst, an action is the main building block of a workflow. The actions you author define a logical unit of work to perform during a workflow run. By creating actions and workflows, you can automate procedures that describe how to build, test, and deploy your code as part of a continuous integration and continuous delivery (CI/CD) system. For more information, see Working with actions.
+ ++ Amazon CodeCatalyst provides software development teams one place to plan work, collaborate on code, and build, test, and deploy + applications with continuous integration/continuous delivery (CI/CD) tools. For more information, see + What is Amazon CodeCatalyst? +
++ With the CodeCatalyst Action Development Kit (ADK), you can build, test, and publish actions to the CodeCatalyst actions catalog, where + other users can add them to workflows. This ADK provides tooling and support to help you develop actions using libraries and frameworks. +
++ In CodeCatalyst, an action is the main building block of a workflow. The actions you author define a logical unit of work to perform + during a workflow run. By creating actions and workflows, you can automate procedures that describe how to build, test, and deploy your + code as part of a continuous integration and continuous delivery (CI/CD) system. For more information, see + Working with actions. +
- -There are two components of the ADK:
-A set of library interfaces you can use to interact with action matadata and CodeCatalyst resources, including actions, workflows, secrets, logs, input variables, output variables, artifacts, and reports.
+ +There are two components of the ADK:
++ A set of library interfaces you can use to interact with action matadata and CodeCatalyst resources, including actions, workflows, + secrets, logs, input variables, output variables, artifacts, and reports. +
- -// @ts-ignore
import * as core from '@aws/codecatalyst-adk-core';
// @ts-ignore
import * as project from '@aws/codecatalyst-project';
// @ts-ignore
import { RunSummaryLevel, RunSummaries } from '@aws/codecatalyst-run-summaries';
// @ts-ignore
import * as space from '@aws/codecatalyst-space';
const destinationBucket = core.getInput('DestinationBucketName')
# => Maps to the destination bucket configuration in CodeCatalyst workflow definition
const srcDir = core.getInput('SourcePath')
# => Maps to the src dir configuration in CodeCatalyst workflow definition
console.log("Running action S3 Publish Action")
let cmd = `aws s3 sync ${srcDir} s3://${destinationBucket}/${space.getSpace().name}/${project.getProject().name}/`
const cmdOutput = core.command(cmd)
console.log(cmdOutput.stdout)
if (cmdOutput.code != 0) {
core.setFailed(cmdOutput.stderr)
} else {
core.setOutputVariable("Files", cmdOutput.stdOut)
}
+
+ Sample Usage
+
+ // @ts-ignore
import * as core from '@aws/codecatalyst-adk-core';
// @ts-ignore
import * as project from '@aws/codecatalyst-project';
// @ts-ignore
import { RunSummaryLevel, RunSummaries } from '@aws/codecatalyst-run-summaries';
// @ts-ignore
import * as space from '@aws/codecatalyst-space';
const destinationBucket = core.getInput('DestinationBucketName')
# => Maps to the destination bucket configuration in CodeCatalyst workflow definition
const srcDir = core.getInput('SourcePath')
# => Maps to the src dir configuration in CodeCatalyst workflow definition
console.log("Running action S3 Publish Action")
let cmd = `aws s3 sync ${srcDir} s3://${destinationBucket}/${space.getSpace().name}/${project.getProject().name}/`
const cmdOutput = core.command(cmd)
console.log(cmdOutput.stdout)
if (cmdOutput.code != 0) {
core.setFailed(cmdOutput.stderr)
} else {
core.setOutputVariable("Files", cmdOutput.stdOut)
}
-
-- ADK command line interface (CLI)
-
-Tool to interact with a set of commands you can use to create, validate, and test actions.
+
+ - ADK command line interface (CLI)
+
+ Tool to interact with a set of commands you can use to create, validate, and test actions.
-
- Sample Usage
-
->> adk init --lang typescript --space <CODECATALYST-SPACE-NAME> --proj <CODECATALYST-PROJECT-NAME> --repo <CODECATALYST-REPO-NAME> --action <ACTION-NAME>
...
>> adk bootstrap
...
>> adk validate
validating...
Missing README file...
action.yml parsing failed...
+
+ Sample Usage
+
+ >> adk init --lang typescript --space <CODECATALYST-SPACE-NAME> --proj <CODECATALYST-PROJECT-NAME> --repo <CODECATALYST-REPO-NAME> --action <ACTION-NAME>
...
>> adk bootstrap
...
>> adk validate
validating...
Missing README file...
action.yml parsing failed...
-The following list contains the ADK CLI commands and information about how to use each command:
-
-- init – Initializes the ADK project locally and produces required configuration files with specific language support.
-- bootstrap – Bootstraps CodeCatalyst action code by reading the action definition file. The ADK SDK is used to develop actions.
-- validate – Validates the action definition and README file.
-- version – Returns the current version of ADK.
-- help – Shows the current set of commands.
-
+ The following list contains the ADK CLI commands and information about how to use each command:
+
+ - init – Initializes the ADK project locally and produces required configuration files with specific language support.
+ - bootstrap – Bootstraps CodeCatalyst action code by reading the action definition file. The ADK SDK is used to develop actions.
+ - validate – Validates the action definition and README file.
+ - version – Returns the current version of ADK.
+ - help – Shows the current set of commands.
+
-
- Installation Guide
-
+
+ Installation Guide
+
-
- Prerequisites
-
-
-- Download the latest version of npm. It is best to use a Node version manager like nvm to install Node.js and npm.
-- Run the following Lerna command:
npm install -g lerna.
-- Lerna is a fast, modern build system for managing and publishing multiple JavaScript/TypeScript packages from the same repository.
-
-
-- Run the following command to install yarn:
npm install --global yarn
-- Yarn is a package manager that doubles down as project manager. You can you work on one-shot projects or large monorepos, as a hobbyist or an enterprise user.
-
-
-
+
+ Prerequisites
+
+
+ Download the latest version of npm. It is best to use a
+ Node version manager like nvm to install Node.js and npm.
+
+ yarn
yarn build
+
-
- Install ADK CLI
-
-
-Run the following npm command to install the ADK CLI package globally:
-
-npm install -g @aws/codecatalyst-adk
-Validate that ADK is running with the following command: adk help
-
+
+ Install ADK CLI
+
+
+ -
+
Run the following npm command to install the ADK CLI package globally:
+
+ npm install -g @aws/codecatalyst-adk
+
+ -
+
Validate that ADK is running with the following command: adk help
+
+
-
- Development
-
+
+ Development
+
-
- Build
-
-Run the following build command:
-$ ./build.sh
+
+ Build
+
+ Run the following build command:
+ yarn build
-
- Testing
-
-Run the following test command:
-$ yarn run test-all
+
+ Testing
+
+ Run the following test command:
+ yarn test
-
- Contribute
-
-You can contribute to the ADK by completing development on a feature branch and creating a pull request:
-
-- Create a branch from main and name it feature-* branch (e.g. feature-add-init-command). Creating the feature branch creates CI validation workflow against the feature- branch.
-- Update the code in your new branch feature-*.
-- Once you're done with feature development, create a pull request from source feature-* branch to destination main branch. This triggers a CI workflow in yourfeature-* branch. Update the pull request with the workflow run in the description section of the pull request.
-- Add reviewers from the reviewer section. Reviewers can be anyone within the organization, but at least one must be a developer from the AEF team.
-- Once you have all the approvals in your pull request, merge the pull request from the UI by choosing squash (not fast forward merge) and reducing the number of commits to just one from the feature branch. This makes rollbacks easy if you have one commit per feature branch. If you have large amount of changes in your pull request, it's best to rethink your development strategy to iteratively develop and push code.
-- On merge, release workflows within the ADK repository will kick-off. This should automatically bump the version of the ADK package for consumption.
-
+
+ Contribute
+
+ You can contribute to the ADK by completing development on a feature branch and creating a pull request:
+
+ -
+ Create a branch from main and name it feature-* branch (e.g.
+ feature-add-init-command). Creating the feature branch creates CI validation workflow against the feature- branch.
+
+ - Update the code in your new branch feature-*.
+ -
+ Once you're done with feature development, create a pull request from source feature-* branch to destination main
+ branch. This triggers a CI workflow in yourfeature-* branch. Update the pull request with the workflow run in the
+ description section of the pull request.
+
+ -
+ Add reviewers from the reviewer section. Reviewers can be anyone within the organization, but at least one must be a developer from the
+ AEF team.
+
+ -
+ Once you have all the approvals in your pull request, merge the pull request from the UI by choosing squash (not fast forward merge) and
+ reducing the number of commits to just one from the feature branch. This makes rollbacks easy if you have one commit per feature branch.
+ If you have large amount of changes in your pull request, it's best to rethink your development strategy to iteratively develop and
+ push code.
+
+ -
+ On merge, release workflows within the ADK repository will kick-off. This should automatically bump the version of the ADK package for
+ consumption.
+
+
-
- Test Coverage Expectations
-
-
-- branches: 90%
-- statements: 90%
-- functions: 90%
-- lines: 90%
-
+
+ Test Coverage Expectations
+
+
+ - branches: 90%
+ - statements: 90%
+ - functions: 90%
+ - lines: 90%
+
-
- ChangeLog
-
-
+
+ ChangeLog
+
+
-
- Security
-
-See CONTRIBUTING for more information.
+
+ Security
+
+ See CONTRIBUTING for more information.
-
- License
-
-This project is licensed under the Apache-2.0 License.
-
Generated using TypeDoc
This project is licensed under the Apache-2.0 License.
+Generated using TypeDoc
+Command output interface providing modeled command output parameters.
-The command output exit code.
-The standard error captured buffer.
-The standard output captured buffer.
-Generated using TypeDoc
Command output interface providing modeled command output parameters.
The command output exit code.
The standard error captured buffer.
The standard output captured buffer.
Generated using TypeDoc
+Action configuration. Consists of an array of inputs.
-Generated using TypeDoc
Action configuration. Consists of an array of inputs.
Generated using TypeDoc
+A boolean to indicate the action requires CI/CD Environment to be configured to run successfully. -To learn more about environments, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/deploy-environments.html.
-Generated using TypeDoc
+ A boolean to indicate the action requires CI/CD Environment to be configured to run successfully. To learn more about environments, see + https://docs.aws.amazon.com/codecatalyst/latest/userguide/deploy-environments.html. +
+Generated using TypeDoc
+Action configuration input.
-Optional DefaultOptional DisplayOptional TypeGenerated using TypeDoc
Action configuration input.
Optional Default
+ Optional DisplayOptional Type
+ Generated using TypeDoc
+The action.yml model interface used by bootstrap and validation of ADK CLI commands.
-Optional ConfigurationOptional DescriptionOptional EnvironmentOptional NameOptional RunsOptional SourcesOptional VersionGenerated using TypeDoc
The action.yml model interface used by bootstrap and validation of ADK CLI commands.
Optional Configuration
+ Optional Description
+ Optional Environment
+ Optional Name
+ Optional Runs
+ Optional Sources
+ Optional Version
+ Generated using TypeDoc
+Specifies whether the action is a JavaScript action, a composite action, or a Docker container action and how the action is executed. -To learn more about run configurations, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-working-runs.html.
-Generated using TypeDoc
+ Specifies whether the action is a JavaScript action, a composite action, or a Docker container action and how the action is executed. To + learn more about run configurations, see + https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-working-runs.html. +
+Generated using TypeDoc
+A boolean to indicate whether the action requires sources. Set to true when the parameter is required. -To learn more about sources, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-sources.html.
-Generated using TypeDoc
+ A boolean to indicate whether the action requires sources. Set to true when the parameter is required. To learn more about sources, see + https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-sources.html. +
+Generated using TypeDoc
+Use the Project construct to query the Project resource in a CodeCatalyst space. To learn more about CodeCatalyst projects, -see https://docs.aws.amazon.com/codecatalyst/latest/userguide/concepts.html#project-concept.
-Generated using TypeDoc
+ Use the Project construct to query the Project resource in a CodeCatalyst space. To learn more about CodeCatalyst projects, see + https://docs.aws.amazon.com/codecatalyst/latest/userguide/concepts.html#project-concept. +
+Generated using TypeDoc
+RunSummary message.
-Optional templateOptional textGenerated using TypeDoc
RunSummary message.
Optional templateOptional text
+ Generated using TypeDoc
+The text attribute is used as a status code and message attribute can be used to pass custom messages. -In future text will be replaced by statusCode.
-Optional messageOptional templateGenerated using TypeDoc
+ The text attribute is used as a status code and message attribute can be used to pass custom messages. In future text will be replaced + by statusCode. +
+Optional message
+ Optional templateGenerated using TypeDoc
+Generated using TypeDoc
Generated using TypeDoc
+Use the Space construct to query the space resource in a CodeCatalyst space. To learn more about CodeCatalyst spaces, -see https://docs.aws.amazon.com/codecatalyst/latest/userguide/concepts.html#space-concept.
-Generated using TypeDoc
+ Use the Space construct to query the space resource in a CodeCatalyst space. To learn more about CodeCatalyst spaces, see + https://docs.aws.amazon.com/codecatalyst/latest/userguide/concepts.html#space-concept. +
+Generated using TypeDoc
+@aws/codecatalyst-adk@aws/codecatalyst-adkADK offers action developers a command-line interface (CLI) to kick off action development.
+ +ADK offers action developers a command-line interface (CLI) to kick off action development.
- -The following three commands are offered:
+ +The following three commands are offered:
- -Generates action definition file in the current directory (.codecatalyst/actions/action.yml by default).
-Example:
-adk init --lang typescript --space MySpace --proj <CODECATALYST-PROJECT-NAME> --repo <CODECATALYST-REPO-NAME> --action <ACTION-NAME>
+
+ adk init
+
+ Generates action definition file in the current directory (.codecatalyst/actions/action.yml by default).
+ Example:
+ adk init --lang typescript --space MySpace --proj <CODECATALYST-PROJECT-NAME> --repo <CODECATALYST-REPO-NAME> --action <ACTION-NAME>
-
- adk bootstrap
-
-Bootstraps action project in the current folder from action.yml file. Bootstrap command generates source code, CI/CD workflow configuration, config files, and a basic readme file.
-Example:
-adk bootstrap -f .codecatalyst/actions/action.yml
+
+ adk bootstrap
+
+
+ Bootstraps action project in the current folder from action.yml file. Bootstrap command generates source code, CI/CD workflow
+ configuration, config files, and a basic readme file.
+
+ Example:
+ adk bootstrap -f .codecatalyst/actions/action.yml
-
- adk validate
-
-Validates action project.
-Example:
-adk validate
+
+ adk validate
+
+ Validates action project.
+ Example:
+ adk validate
-
Generated using TypeDoc
Generated using TypeDoc
+@aws/codecatalyst-adk-core@aws/codecatalyst-adk-coreADK Core offers action developers library interfaces that makes action development easier. Action authors can interact with core metadata information about the action, workflows, output variables, artifacts, reports, etc, giving the action author ability to fully model the input and output of the action code.
+ ++ ADK Core offers action developers library interfaces that makes action development easier. Action authors can interact with core + metadata information about the action, workflows, output variables, artifacts, reports, etc, giving the action author ability to fully + model the input and output of the action code. +
- -const adkCore = require('@aws/codecatalyst-adk-core');
const space = require('@aws/codecatalyst-space');
# => Metadata information about CodeCatalyst space
const project = require('@aws/codecatalyst-project');
# => Metadata information about CodeCatalyst project
const destinationBucket = core.getInput('DestinationBucketName')
# => Maps to the destination bucket configuration in CodeCatalyst workflow definition
const srcDir = core.getInput('SourcePath')
# => Maps to the src dir configuration in CodeCatalyst workflow definition
const actionName = core.getActionName()
console.log("Running action ${actionName}")
let cmd = `aws s3 sync ${srcDir} s3://${destinationBucket}/${space.getSpace().name}/${project.getProject().name}/`
const cmdOutput = core.command(cmd)
console.log(cmdOutput.stdout)
if (cmdOutput.code != 0) {
core.setFailed(cmdOutput.stderr)
} else {
core.setOutputVariable("Files", cmdOutput.stdOut)
}
+
+ Usage
+
+ const adkCore = require('@aws/codecatalyst-adk-core');
const space = require('@aws/codecatalyst-space');
# => Metadata information about CodeCatalyst space
const project = require('@aws/codecatalyst-project');
# => Metadata information about CodeCatalyst project
const destinationBucket = core.getInput('DestinationBucketName')
# => Maps to the destination bucket configuration in CodeCatalyst workflow definition
const srcDir = core.getInput('SourcePath')
# => Maps to the src dir configuration in CodeCatalyst workflow definition
const actionName = core.getActionName()
console.log("Running action ${actionName}")
let cmd = `aws s3 sync ${srcDir} s3://${destinationBucket}/${space.getSpace().name}/${project.getProject().name}/`
const cmdOutput = core.command(cmd)
console.log(cmdOutput.stdout)
if (cmdOutput.code != 0) {
core.setFailed(cmdOutput.stderr)
} else {
core.setOutputVariable("Files", cmdOutput.stdOut)
}
-Generated using TypeDoc
Generated using TypeDoc
+@aws/codecatalyst-adk-model-parser@aws/codecatalyst-adk-model-parserADK Model Parses is an internal ADK package used to parse and sanitize action.yml into a model when adk bootstrap command is executed.
-Generated using TypeDoc
+ ADK Model Parses is an internal ADK package used to parse and sanitize action.yml into a model when adk bootstrap command is executed. +
+Generated using TypeDoc
+@aws/codecatalyst-adk-utils@aws/codecatalyst-adk-utilsADK Utils is a package to store utility functions.
-Generated using TypeDoc
ADK Utils is a package to store utility functions.
+Generated using TypeDoc
+@aws/codecatalyst-project@aws/codecatalyst-projectUse the project construct to query the project resource metadata in a CodeCatalyst space.
+ +Use the project construct to query the project resource metadata in a CodeCatalyst space.
- -const project = require('@aws/codecatalyst-project');
console.log("Running action in ${project.getProject().name} project")
+
+ Usage
+
+ const project = require('@aws/codecatalyst-project');
console.log("Running action in ${project.getProject().name} project")
-Generated using TypeDoc
Generated using TypeDoc
+@aws/codecatalyst-run-summaries@aws/codecatalyst-run-summariesUse the run-summaries construct to set custom summary messages during the execution of actions that will be surfaced on the CodeCatalyst workflows UI.
+ ++ Use the run-summaries construct to set custom summary messages during the execution of actions that will be surfaced on the CodeCatalyst + workflows UI. +
- - import { RunSummaryLevel, RunSummaries } from '@aws/codecatalyst-run-summaries';
try {
// execute action code here
} catch (error) {
// Since we want to surface an error, we use RunSummaryLevel.ERROR to specify this is an error
RunSummaries.addRunSummary(error, RunSummaryLevel.ERROR)
}
+
+ Usage
+
+ import { RunSummaryLevel, RunSummaries } from '@aws/codecatalyst-run-summaries';
try {
// execute action code here
} catch (error) {
// Since we want to surface an error, we use RunSummaryLevel.ERROR to specify this is an error
RunSummaries.addRunSummary(error, RunSummaryLevel.ERROR)
}
- import { RunSummaryLevel, RunSummaries } from '@aws/codecatalyst-run-summaries';
import * as adkCore from '@aws/codecatalyst-adk-core';
const cmdOutput = adkCore.command(/* command here */)
// if the exit code of the command is a failure
if (cmdOutput.code != 0)
// pass the error message of the command as the summary message text
RunSummaries.addRunSummary(cmdOutput.stderr.toString(), RunSummaryLevel.ERROR)
}
+ import { RunSummaryLevel, RunSummaries } from '@aws/codecatalyst-run-summaries';
import * as adkCore from '@aws/codecatalyst-adk-core';
const cmdOutput = adkCore.command(/* command here */)
// if the exit code of the command is a failure
if (cmdOutput.code != 0)
// pass the error message of the command as the summary message text
RunSummaries.addRunSummary(cmdOutput.stderr.toString(), RunSummaryLevel.ERROR)
}
-
Generated using TypeDoc
Generated using TypeDoc
+@aws/codecatalyst-space@aws/codecatalyst-spaceUse the space construct to query CodeCatalyst space resource metadata.
+ +Use the space construct to query CodeCatalyst space resource metadata.
- -const codecatalystSpace = require('@aws/codecatalyst-space');
console.log("Running action in ${codecatalystSpace.getSpace().name} space")
+
+ Usage
+
+ const codecatalystSpace = require('@aws/codecatalyst-space');
console.log("Running action in ${codecatalystSpace.getSpace().name} space")
-Generated using TypeDoc
Generated using TypeDoc
+Const Generated using TypeDoc
ConstGenerated using TypeDoc
+
Utility class wrapping core methods.
-