AWS codecatalyst documentation change
Summary
Restructured documentation with step-by-step guidance and updated references to secrets management
Security assessment
Enhanced documentation about handling secrets in custom actions but no vulnerability fixes
Diff
diff --git a/codecatalyst/latest/adk/adk-configure-third-party.md b/codecatalyst/latest/adk/adk-configure-third-party.md index 58abc9f82..b302c10ee 100644 --- a/codecatalyst/latest/adk/adk-configure-third-party.md +++ b/codecatalyst/latest/adk/adk-configure-third-party.md @@ -5 +5 @@ -Configure custom action filesTesting a custom action in a workflowMerge changes into default branch and publish action +Step 1: Configure custom action filesStep 2: Test a custom action in a workflowStep 3: Merge changes into default branches and publish actions @@ -7 +7 @@ Configure custom action filesTesting a custom action in a workflowMerge changes -# Configuring custom actions for third-party integrations +# Configuring custom actions for third-party integrations in CodeCatalyst @@ -19 +19 @@ As a third-party provider, you're responsible for testing the custom action, mak -Before you can configure files for third-party capabilities, you must complete the prerequisites and the first four steps from the [Getting started with the Action Development Kit](./getting-started.html) walkthrough: +Before you can configure files for third-party capabilities, you must complete the prerequisites and the first four steps from the [Getting started with custom actions in CodeCatalyst](./getting-started.html) walkthrough: @@ -34 +34,9 @@ Before you can configure files for third-party capabilities, you must complete t -## Configure custom action files +###### Topics + + * Step 1: Configure custom action files + * Step 2: Test a custom action in a workflow + * Step 3: Merge changes into default branches and publish actions + + + +## Step 1: Configure custom action files @@ -40 +48 @@ You can configure the generated files to incorporate secrets, include installati - 1. Configure the `.codecatalyst/actions/action.yml` file to update the `Description` of your custom action. Additionally, you can add code to accept secrets as user inputs, or use the `Default` value from the CodeCatalyst secrets to access secrets. You can also add your own secrets. For more information, [Creating secrets](./adk-create-secrets.html). + 1. Configure the `.codecatalyst/actions/action.yml` file to update the `Description` of your custom action. Additionally, you can add code to accept secrets as user inputs, or use the `Default` value from the CodeCatalyst secrets to access secrets. You can also add your own secrets. For more information, [Creating secrets in CodeCatalyst for sensitive data](./adk-create-secrets.html). @@ -313 +321 @@ You can also use the source control options available in the IDE you’re using -## Testing a custom action in a workflow +## Step 2: Test a custom action in a workflow @@ -400 +408 @@ After committing your workflow definition file, it cannot be associated with ano -## Merge changes into default branch and publish action +## Step 3: Merge changes into default branches and publish actions @@ -402 +410 @@ After committing your workflow definition file, it cannot be associated with ano -After a successful workflow run, merge the feature branch to the default branch in order to publish the action to the CodeCatalyst actions catalog. For more information, see [Publishing an action](./actions-publishing.html). +After a successful workflow run, merge the feature branch to the default branch in order to publish the action to the CodeCatalyst actions catalog. For more information, see [Publishing a custom action](./actions-publishing.html). @@ -410 +418 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Outgoing webhook action using ADK +Example: Outgoing webhook action using ADK @@ -412 +420 @@ Outgoing webhook action using ADK -Creating secrets +Creating secrets for sensitive data