Skip to content

Commit

Permalink
docs(client-codebuild): This release adds support for a new webhook e…
Browse files Browse the repository at this point in the history 
…vent: PULL_REQUEST_CLOSED.
  • Loading branch information
awstools committed Mar 8, 2024
1 parent c0f750c commit 41f3b5e
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 75 deletions.
5 changes: 4 additions & 1 deletion clients/client-codebuild/src/commands/StartBuildCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ export interface StartBuildCommandOutput extends StartBuildOutput, __MetadataBea

/**
* @public
* <p>Starts running a build.</p>
* <p>Starts running a build with the settings defined in the project. These setting include: how to run a build,
* where to get the source code, which build environment to use, which build commands to run, and where to store the build output.</p>
* <p>You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that
* specific start build request. The settings in the project are unaltered.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
165 changes: 94 additions & 71 deletions clients/client-codebuild/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3424,77 +3424,94 @@ export interface WebhookFilter {
* <p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>,
* <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>,
* <code>FILE_PATH</code>, and <code>COMMIT_MESSAGE</code>. </p>
* <dl>
* <dt>
* EVENT
* </dt>
* <dd>
* <p> A webhook event triggers a build when the provided <code>pattern</code>
* matches one of five event types: <code>PUSH</code>,
* <ul>
* <li>
* <p>
* EVENT
* </p>
* <ul>
* <li>
* <p> A webhook event triggers a build when the provided <code>pattern</code>
* matches one of six event types: <code>PUSH</code>,
* <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>,
* <code>PULL_REQUEST_CLOSED</code>,
* <code>PULL_REQUEST_REOPENED</code>, and
* <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are
* specified as a comma-separated string. For example, <code>PUSH,
* PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull
* request created, and pull request updated events. </p>
* <note>
* <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub
* Enterprise only. </p>
* </note>
* </dd>
* <dt>
* ACTOR_ACCOUNT_ID
* </dt>
* <dd>
* <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or
* Bitbucket account ID matches the regular expression <code>pattern</code>.
* </p>
* </dd>
* <dt>
* HEAD_REF
* </dt>
* <dd>
* <p> A webhook event triggers a build when the head reference matches the
* regular expression <code>pattern</code>. For example,
* <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are
* specified as a comma-separated string. For example, <code>PUSH,
* PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull
* request created, and pull request updated events. </p>
* <note>
* <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub
* Enterprise only. </p>
* </note>
* </li>
* </ul>
* </li>
* <li>
* <p>ACTOR_ACCOUNT_ID</p>
* <ul>
* <li>
* <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or
* Bitbucket account ID matches the regular expression <code>pattern</code>.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>HEAD_REF</p>
* <ul>
* <li>
* <p> A webhook event triggers a build when the head reference matches the
* regular expression <code>pattern</code>. For example,
* <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p>
* <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub
* Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
* </p>
* </dd>
* <dt>
* BASE_REF
* </dt>
* <dd>
* <p> A webhook event triggers a build when the base reference matches the
* regular expression <code>pattern</code>. For example,
* <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub
* Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
* </p>
* </li>
* </ul>
* </li>
* <li>
* <p>BASE_REF</p>
* <ul>
* <li>
* <p> A webhook event triggers a build when the base reference matches the
* regular expression <code>pattern</code>. For example,
* <code>refs/heads/branch-name</code>. </p>
* <note>
* <p> Works with pull request events only. </p>
* </note>
* </dd>
* <dt>
* FILE_PATH
* </dt>
* <dd>
* <p> A webhook triggers a build when the path of a changed file matches the
* regular expression <code>pattern</code>. </p>
* <note>
* <p> Works with GitHub and Bitbucket events push and pull requests events.
* Also works with GitHub Enterprise push events, but does not work with
* GitHub Enterprise pull request events. </p>
* </note>
* </dd>
* <dt>COMMIT_MESSAGE</dt>
* <dd>
* <p>A webhook triggers a build when the head commit message matches the
* regular expression <code>pattern</code>.</p>
* <note>
* <p> Works with GitHub and Bitbucket events push and pull requests events.
* Also works with GitHub Enterprise push events, but does not work with
* GitHub Enterprise pull request events. </p>
* </note>
* </dd>
* </dl>
* <note>
* <p> Works with pull request events only. </p>
* </note>
* </li>
* </ul>
* </li>
* <li>
* <p>FILE_PATH</p>
* <ul>
* <li>
* <p> A webhook triggers a build when the path of a changed file matches the
* regular expression <code>pattern</code>. </p>
* <note>
* <p> Works with GitHub and Bitbucket events push and pull requests events.
* Also works with GitHub Enterprise push events, but does not work with
* GitHub Enterprise pull request events. </p>
* </note>
* </li>
* </ul>
* </li>
* <li>
* <p>COMMIT_MESSAGE</p>
* <ul>
* <li>
* <p>A webhook triggers a build when the head commit message matches the
* regular expression <code>pattern</code>.</p>
* <note>
* <p> Works with GitHub and Bitbucket events push and pull requests events.
* Also works with GitHub Enterprise push events, but does not work with
* GitHub Enterprise pull request events. </p>
* </note>
* </li>
* </ul>
* </li>
* </ul>
*/
type: WebhookFilterType | undefined;

Expand Down Expand Up @@ -6936,16 +6953,22 @@ export interface StartBuildInput {

/**
* @public
* <p>A buildspec file declaration that overrides, for this build only, the latest one
* already defined in the build project.</p>
* <p> If this value is set, it can be either an inline buildspec definition, the path to an
* <p>A buildspec file declaration that overrides the latest one defined
* in the build project, for this build only. The buildspec defined on the project is not changed.</p>
* <p>If this value is set, it can be either an inline buildspec definition, the path to an
* alternate buildspec file relative to the value of the built-in
* <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket.
* The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec
* file using its ARN (for example,
* <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not
* provided or is set to an empty string, the source code must contain a buildspec file in
* its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </p>
* its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>.</p>
* <note>
* <p>Since this property allows you to change the build commands that will run in the container,
* you should note that an IAM principal with the ability to call this API and set this parameter
* can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location
* like a file in your source repository or a Amazon S3 bucket.</p>
* </note>
*/
buildspecOverride?: string;

Expand Down
Loading

0 comments on commit 41f3b5e

Please sign in to comment.