npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@aws/codecatalyst-workflows-sdk

v0.1.5-preview.6

Published

This is the codecatalysts workflow sdk. This defines the workflow configuration a for codecatalyst project.

Downloads

12,517

Readme

CodeCatalyst Workflows SDK

Description

A JavaScript SDK for CodeCatalyst Workflows.

This SDK is meant to aid users in creating Amazon CodeCatalyst Workflows by providing a client to syntactically validate a workflow yaml prior to committing the file.

Installing

To install this package, simply type add or install @aws/codecatalyst-workflows-sdk using your favorite package manager:

npm install @aws/codecatalyst-workflows-sdk
yarn add @aws/codecatalyst-workflows-sdk
pnpm add @aws/codecatalyst-workflows-sdk

Getting Started

Import

To start using the sdk to validate your workflow yaml files import the WorkflowDefinition Module from the client

// es5 example
const { WorkflowDefinition } = require("@aws/codecatalyst-workflows-sdk");
//es6 example
const { WorkflowDefinition } = require("@aws/codecatalyst-workflows-sdk");

Usage

To validate your workflow yaml file use the validate command on the WorkflowDefinition class. An example can be found below

const { WorkflowDefinition } = require("@aws/codecatalyst-workflows-sdk");
const { load } = require("js-yaml");

const workflowYaml = `
Name: PushWorkflow
SchemaVersion: 1.0
Triggers:
  - Type: PULLREQUEST
    Events:
      - "DRAFT"
Actions:
  BackendBuildAndPackage:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Outputs:
      Artifacts:
        - Name: backend
          Files:
            - "**/*"
    Configuration:
      Steps:
        - Run: echo "Building Backend Artifacts..."
`

const validationResult = WorkflowDefinition.validate(load(workflowYaml))

Actions that are supported

  • aws/build@v1
  • aws/managed-test@v1
  • aws/github-actions-runner@v1

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.