Ajouter des composants de flux de travail à un plan

Un flux de travail est utilisé par les CodeCatalyst projets Amazon pour exécuter des actions basées sur des déclencheurs. Vous pouvez utiliser des composants de flux de travail pour créer et assembler des fichiers YAML de flux de travail. Pour plus d’informations, consultez YAMLDéfinition du flux de travail.

Pour importer des composants de flux de travail Amazon CodeCatalyst Blueprints

Dans votre blueprint.ts fichier, ajoutez les éléments suivants :

import { WorkflowBuilder, Workflow } from '@amazon-codecatalyst/codecatalyst-workflows'

Exemples de composants de flux de travail

WorkflowBuilder composant

Vous pouvez utiliser une classe pour créer une définition de flux de travail. La définition peut être donnée à un composant de flux de travail pour le rendu dans un référentiel.

import { WorkflowBuilder } from '@amazon-codecatalyst/codecatalyst-workflows'

const workflowBuilder = new WorkflowBuilder({} as Blueprint, {
  Name: 'my_workflow',
});

// trigger the workflow on pushes to branch 'main'
workflowBuilder.addBranchTrigger(['main']);

// add a build action
workflowBuilder.addBuildAction({
  // give the action a name
  actionName: 'build_and_do_some_other_stuff',

  // the action pulls from source code
  input: {
    Sources: ['WorkflowSource'],
  },

  // the output attempts to autodiscover test reports, but not in the node modules
  output: {
    AutoDiscoverReports: {
      Enabled: true,
      ReportNamePrefix: AutoDiscovered,
      IncludePaths: ['**/*'],
      ExcludePaths: ['*/node_modules/**/*'],
    },
  },
  // execute some arbitrary steps
  steps: [
    'npm install',
    'npm run myscript',
    'echo hello-world',
  ],
  // add an account connection to the workflow
  environment: convertToWorkflowEnvironment(myEnv),
});

Composant du projet Workflow

L'exemple suivant montre comment un composant Projen peut être utilisé pour écrire un flux de travail YAML dans un référentiel :

import { Workflow } from '@amazon-codecatalyst/codecatalyst-workflows'

...

const repo = new SourceRepository
const blueprint = this;
const workflowDef = workflowBuilder.getDefinition()

// creates a workflow.yaml at .aws/workflows/${workflowDef.name}.yaml
new Workflow(blueprint, repo, workflowDef);

// can also pass in any object and have it rendered as a yaml. This is unsafe and may not produce a valid workflow
new Workflow(blueprint, repo, {... some object ...});

Connexion à un environnement

De nombreux flux de travail doivent être exécutés via une connexion à un compte AWS. Les flux de travail gèrent cela en autorisant les actions à se connecter à des environnements avec des spécifications de nom de compte et de rôle.

import { convertToWorkflowEnvironment } from '@amazon-codecatalyst/codecatalyst-workflows'


const myEnv = new Environment(...);

// can be passed into a workflow constructor
const workflowEnvironment = convertToWorkflowEnvironment(myEnv);


// add a build action
workflowBuilder.addBuildAction({
  ...
  // add an account connection to the workflow
  environment: convertToWorkflowEnvironment(myEnv),
});