teliaoss/appsync-resource

AWS AppSync Concourse资源和GitHub Action

![Build Status]([] ![Go Report Card]([]

镜像概述和主要用途

这是一个Concourse资源和GitHub Action，用于更新AWS AppSync的schema和解析器，使用Go语言编写。它提供了便捷的方式在CI/CD流程中管理AppSync服务的schema和解析器配置。

核心功能和特性

• 支持通过Concourse资源或GitHub Action更新AppSync schema
• 支持更新AppSync现有schema的解析器
• 可配置AWS区域，默认使用eu-west-1
• 支持通过文件指定schema和解析器配置

使用场景和适用范围

适用于需要在CI/CD流程中自动化管理AWS AppSync服务的场景，特别是在使用Concourse或GitHub Actions作为CI/CD工具的开发团队中。

使用方法和配置说明

Concourse

源配置（Source Configuration）

out: 更新或创建schema

通过schema_file指定的schema文件更新/创建AppSync schema，或/和通过resolvers_file指定的解析器JSON文件更新AppSync现有schema的解析器。

参数

• schema_file: 可选。由任务输出提供的.graphql schema文件，如果未指定resolvers_file，则此字段为必填项。
• resolvers_file: 可选。由任务输出提供的.yml解析器文件，如果未指定schema_file，则此字段为必填项。

示例配置

资源类型（Resource type）

yaml
resource_types:
- name: appsync-resource
  type: docker-image
  source:
    repository: teliaoss/appsync-resource

资源（Resource）

yaml
resources:
- name: appsync-resource
  type: appsync-resource
  source:
    access_key_id: ((access-key))
    secret_access_key: ((secret-key))
    session_token: ((session-token))
    region_name: "eu-west-1"
    api_id: ((api-id))

计划（Plan）

yaml
- put: appsync-resource
  params: 
    schema_file: "path/to/schema.graphql"
    resolvers_file: "path/to/resolvers.yml"

参数文件示例

https://github.com/telia-oss/appsync-resource/blob/master/schema.graphql
https://github.com/telia-oss/appsync-resource/blob/master/resolvers.yml

Github Action

参数

示例配置

yaml
jobs:
  appsync:
    runs-on: ubuntu-latest

    steps:
    - name: update appsync
      uses: telia-oss/appsync-action@main
      with:
        schema_file: "workspace/schema.graphql"
        resolvers_file: "workspace/resolvers.yml"
        access_key_id: {YOUR_ACCESS_KEY_ID}  
        secret_access_key: {YOUR_SECRET_ACCESS_KEY} 
        session_token: {YOUR_SESSION_TOKEN}  
        api_id: "znvjdp3n25epx"
        ci: "github"