Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore (docs): Made sure CodeBuild and CodeCommit always have the AWS prefix #1707

Merged
merged 3 commits into from
Feb 8, 2019
Merged

chore (docs): Made sure CodeBuild and CodeCommit always have the AWS prefix #1707

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80ee2bc
Made sure CodeBuild and CodeCommit always have the AWS prefix
Doug-AWS Feb 7, 2019
390318d
Update README.md
Doug-AWS Feb 7, 2019
7136f4d
Update README.md
Doug-AWS Feb 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions packages/@aws-cdk/aws-codebuild/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
## AWS CodeBuild Construct Library
# AWS CodeBuild

AWS CodeBuild is a fully managed continuous integration service that compiles
source code, runs tests, and produces software packages that are ready to
deploy. With CodeBuild, you don’t need to provision, manage, and scale your own
build servers. CodeBuild scales continuously and processes multiple builds
deploy. With AWS CodeBuild, you don’t need to provision, manage, and scale your own
build servers. AWS CodeBuild scales continuously and processes multiple builds
concurrently, so your builds are not left waiting in a queue. You can get
started quickly by using prepackaged build environments, or you can create
custom build environments that use your own build tools. With CodeBuild, you are
custom build environments that use your own build tools. With AWS CodeBuild, you are
charged by the minute for the compute resources you use.

### Installation
## Installation

Install the module:

Expand All @@ -27,15 +27,15 @@ The `codebuild.Project` construct represents a build project resource. See the
reference documentation for a comprehensive list of initialization properties,
methods and attributes.

### Source
## Source

Build projects are usually associated with a _source_, which is specified via
the `source` property which accepts a class that extends the `BuildSource`
abstract base class. The supported sources are:

#### `NoSource`
### `NoSource`

This is the default and implies that no source will be associated with this
This is the default and implies that no source is associated with this
build project.

The `buildSpec` option is required in this case.
Expand All @@ -45,7 +45,7 @@ CodeBuild!`:

[Minimal Example](./test/integ.defaults.lit.ts)

#### `CodeCommitSource`
### `CodeCommitSource`

Use an AWS CodeCommit repository as the source of this build:

Expand All @@ -59,9 +59,9 @@ new codebuild.Project(this, 'MyFirstCodeCommitProject', {
});
```

#### `S3BucketSource`
### `S3BucketSource`

Create a CodeBuild project with an S3 bucket as the source:
Create an AWS CodeBuild project with an S3 bucket as the source:

```ts
import codebuild = require('@aws-cdk/aws-codebuild');
Expand All @@ -76,12 +76,12 @@ new codebuild.Project(this, 'MyProject', {
});
```

#### `CodePipelineSource`
### `CodePipelineSource`

Used as a special source type when an AWS CodeBuild project is used as an AWS
CodePipeline action.

#### `GitHubSource` and `GitHubEnterpriseSource`
### `GitHubSource` and `GitHubEnterpriseSource`

These source types can be used to build code from a GitHub repository.
Example:
Expand All @@ -97,13 +97,13 @@ const gitHubSource = new codebuild.GitHubSource({
});
```

#### `BitBucketSource`
### `BitBucketSource`

This source type can be used to build code from a BitBucket repository.

### Environment
## Environment

By default, projects will use a small instance with an Ubuntu 14.04 image. You
By default, projects use a small instance with an Ubuntu 14.04 image. You
can use the `environment` property to customize the build environment:

* `buildImage` defines the Docker image used. See [Images](#images) below for
Expand All @@ -113,7 +113,7 @@ can use the `environment` property to customize the build environment:
* `environmentVariables` can be set at this level (and also at the project
level).

### Images
## Images

The AWS CodeBuild library supports both Linux and Windows images via the
`LinuxBuildImage` and `WindowsBuildImage` classes, respectively.
Expand All @@ -140,12 +140,12 @@ The following example shows how to define an image from an ECR repository:

[ECR example](./test/integ.ecr.lit.ts)

### Events
## Events

AWS CodeBuild projects can be used either as a source for events or be triggered
by events via an event rule.

#### Using Project as an event target
### Using Project as an event target

The `Project` construct implements the `IEventRuleTarget` interface. This means
that it can be used as a target for event rules:
Expand All @@ -155,7 +155,7 @@ that it can be used as a target for event rules:
codeCommitRepository.onCommit('OnCommit', project);
```

#### Using Project as an event source
### Using Project as an event source

To define CloudWatch event rules for build projects, use one of the `onXxx`
methods:
Expand All @@ -166,9 +166,9 @@ rule.addTarget(lambdaFunction);
```


### Using an AWS CodeBuild Project as an AWS CodePipeline action
## Using an AWS CodeBuild Project as an AWS CodePipeline action

Example of a Project used in CodePipeline, alongside CodeCommit:
Example of a Project used in CodePipeline, alongside AWS CodeCommit:

```ts
import codebuild = require('@aws-cdk/aws-codebuild');
Expand Down Expand Up @@ -233,9 +233,9 @@ project.addToPipelineAsTest(buildStage, 'IntegrationTest', {
});
```

### Secondary sources and artifacts
## Secondary sources and artifacts

CodeBuild Projects can get their sources from multiple places, and produce
AWS CodeBuild Projects can get their sources from multiple places, and produce
multiple outputs. For example:

```ts
Expand All @@ -261,7 +261,7 @@ const project = new codebuild.Project(this, 'MyProject', {
Note that the `identifier` property is required for both secondary sources and
artifacts.

The contents of the secondary source will be available to the build under the
The contents of the secondary source is available to the build under the
directory specified by the `CODEBUILD_SRC_DIR_<identifier>` environment variable
(so, `CODEBUILD_SRC_DIR_source2` in the above case).

Expand Down Expand Up @@ -298,12 +298,12 @@ const project = new codebuild.Project(this, 'MyProject', {
});
```

#### Multiple inputs and outputs in CodePipeline
### Multiple inputs and outputs in CodePipeline

When you want to have multiple inputs and/or outputs for a Project used in a
Pipeline, instead of using the `secondarySources` and `secondaryArtifacts`
properties, you need to use the `additionalInputArtifacts` and
`additionalOutputArtifactNames` properties of the CodeBuild CodePipeline
`additionalOutputArtifactNames` properties of the AWS CodeBuild CodePipeline
Actions. Example:

```ts
Expand All @@ -326,8 +326,8 @@ const buildAction = project.addToPipeline(buildStage, 'Build', {
});
```

**Note**: when a CodeBuild Action in a Pipeline has more than one output, it
will only use the `secondary-artifacts` field of the buildspec, never the
**Note**: when an AWS CodeBuild Action in a Pipeline has more than one output, it
only uses the `secondary-artifacts` field of the buildspec, never the
primary output specification directly under `artifacts`. Because of that, it
pays to name even your primary output artifact on the Pipeline, like we did
above, so that you know what name to use in the buildspec.
Expand Down