在工作流图中显示应用程序 URL - Amazon CodeCatalyst

Amazon CodeCatalyst 不再向新客户开放。现有客户可以继续正常使用该服务。有关更多信息，请参阅 如何从 CodeCatalyst 迁移。

在工作流图中显示应用程序 URL

如果您的工作流部署了一个应用程序，则您可以配置 Amazon CodeCatalyst 以将该应用程序的 URL 显示为可单击链接。此链接显示在 CodeCatalyst 控制台中已部署它的操作中。以下工作流图显示了位于操作底部的查看应用程序 URL。

查看应用程序 URL

通过使该 URL 在 CodeCatalyst 控制台中可单击，可以快速验证应用程序部署。

注意

部署到 Amazon ECS 操作不支持应用程序 URL。

要启用此功能，请向操作添加名称包含 appurl 或 endpointurl 的输出变量。您可以使用带有连接符（-）、下划线（_）或空格（ ）的名称，也可以不使用这些字符。此字符串不区分大小写。将变量的值设置为已部署的应用程序的 http 或 https URL。

注意

如果要更新现有输出变量以包含 app url 或 endpoint url 字符串，请更新对该变量的所有引用以使用新的变量名。

有关详细步骤，请参阅下列过程之一：

配置完 URL 后，请按照以下说明操作来验证它是否按预期显示：

在“AWS CDK 部署”操作中显示应用程序 URL

  1. 如果您使用的是 AWS CDK 部署操作，请在 AWS CDK 应用程序代码中添加 CfnOutput 构造（一个键值对）：

    • 键名称必须包含 appurl 或 endpointurl，可以带有连接符（-）、下划线（_）或空格（ ），也可以不使用这些字符。此字符串不区分大小写。

    • 值必须是已部署的应用程序的 http 或 https URL。

    例如，您的 AWS CDK 代码可能与以下内容类似：

    import { Duration, Stack, StackProps, CfnOutput, RemovalPolicy} from 'aws-cdk-lib';
import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
import * as s3 from 'aws-cdk-lib/aws-s3';
import { Construct } from 'constructs';
import * as cdk from 'aws-cdk-lib';
export class HelloCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
    const bucket = new s3.Bucket(this, 'amzn-s3-demo-bucket', {
      removalPolicy: RemovalPolicy.DESTROY,
    });
    new CfnOutput(this, 'APP-URL', {
      value: https://mycompany.myapp.com,
      description: 'The URL of the deployed application',
      exportName: 'myApp',
    });
    ...
  }
}

    有关 CfnOutput 构造的更多信息，请参阅《AWS Cloud Development Kit (AWS CDK) API 参考》中的 interface CfnOutputProps。

  2. 保存并提交您的代码。

  3. 继续执行验证是否已添加应用程序 URL。

在“部署 CloudFormation 堆栈”操作中显示应用程序 URL

  1. 如果您使用的是部署 CloudFormation 堆栈操作，请在 CloudFormation 模板或 AWS SAM 模板的 Outputs 部分中添加具有以下特征的输出：

    • 键（也称作逻辑 ID）必须包含 appurl 或 endpointurl，可以带有连接符（-）、下划线（_）或空格（ ），也可以不使用这些字符。此字符串不区分大小写。

    • 值必须是已部署的应用程序的 http 或 https URL。

    例如，您的 CloudFormation 模板可能与以下内容类似：

    "Outputs" : {
  "APP-URL" : {
    "Description" : "The URL of the deployed app",
    "Value" : "https://mycompany.myapp.com",
    "Export" : {
      "Name" : "My App"
    }
  }
}

    有关 CloudFormation 输出的更多信息，请参阅《AWS CloudFormation 用户指南》中的输出。

  2. 保存并提交您的代码。

  3. 继续执行验证是否已添加应用程序 URL。

在所有其他操作中显示应用程序 URL

如果您使用另一个操作（例如构建操作或 GitHub Actions）来部署应用程序，请执行以下操作以显示应用程序 URL。

  1. 在工作流定义文件中操作的 Inputs 或 Steps 部分中定义环境变量。此变量必须具有以下特征：

    • name 必须包含 appurl 或 endpointurl，可以带有连接符（-）、下划线（_）或空格（ ），也可以不使用这些字符。此字符串不区分大小写。

    • 值必须是已部署的应用程序的 http 或 https URL。

    例如，构建操作可能与以下内容类似：

    Build-action:
  Identifier: aws/build@v1
  Inputs:
    Variables:
      - Name: APP-URL
        Value: https://mycompany.myapp.com

    ...或与以下内容类似：

    Actions:
  Build:
    Identifier: aws/build@v1
    Configuration:    
      Steps:
        - Run: APP-URL=https://mycompany.myapp.com

    有关定义环境变量的更多信息，请参阅定义变量。

  2. 导出变量。

    例如，您的构建操作可能与以下内容类似：

    Build-action:
  ...
  Outputs:
    Variables:
      - APP-URL

    有关导出变量的信息，请参阅导出变量以便其他操作使用。

  3. （可选）选择验证，在提交之前验证工作流的 YAML 代码。

  4. 选择提交，输入提交消息，然后再次选择提交。

  5. 继续执行验证是否已添加应用程序 URL。

验证是否已添加应用程序 URL

  • 启动工作流运行（如果它未自动启动）。新运行的应用程序 URL 应在其工作流图中显示为可单击链接。有关启动运行的更多信息，请参阅手动启动工作流运行。