docs(client-codebuild): This release adds support for new webhook events (RELEASED and PRERELEASED) and filter types (TAG_NAME and RELEASE_NAME).

Author: awstools

clients/client-codebuild/src/models/models_0.ts

@@ -3449,9 +3449,9 @@ export type WebhookFilterType = (typeof WebhookFilterType)[keyof typeof WebhookF
  */
 export interface WebhookFilter {
   /**
-   * <p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>,
+   * <p> The type of webhook filter. There are eight 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>
+   *             <code>FILE_PATH</code>, <code>COMMIT_MESSAGE</code>, <code>TAG_NAME</code>, and <code>RELEASE_NAME</code>. </p>
    *          <ul>
    *             <li>
    *                <p>
@@ -3460,17 +3460,17 @@ export interface WebhookFilter {
    *                <ul>
    *                   <li>
    *                      <p> A webhook event triggers a build when the provided <code>pattern</code>
-   *                             matches one of six event types: <code>PUSH</code>,
+   *                             matches one of eight 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
+   *                             <code>PULL_REQUEST_CLOSED</code>, <code>PULL_REQUEST_REOPENED</code>,
+   *                             <code>PULL_REQUEST_MERGED</code>, <code>RELEASED</code>, and <code>PRERELEASED</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>
+   *                                 Enterprise only. The <code>RELEASED</code> and <code>PRERELEASED</code> work
+   *                                 with GitHub only.</p>
    *                      </note>
    *                   </li>
    *                </ul>
@@ -3492,9 +3492,10 @@ export interface WebhookFilter {
    *                      <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>
+   *                      <note>
+   *                         <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub
+   *                             Enterprise pull request, Bitbucket push, and Bitbucket pull request events.</p>
+   *                      </note>
    *                   </li>
    *                </ul>
    *             </li>
@@ -3539,6 +3540,30 @@ export interface WebhookFilter {
    *                   </li>
    *                </ul>
    *             </li>
+   *             <li>
+   *                <p>TAG_NAME</p>
+   *                <ul>
+   *                   <li>
+   *                      <p>A webhook triggers a build when the tag name of the release matches the
+   *                             regular expression <code>pattern</code>.</p>
+   *                      <note>
+   *                         <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p>
+   *                      </note>
+   *                   </li>
+   *                </ul>
+   *             </li>
+   *             <li>
+   *                <p>RELEASE_NAME</p>
+   *                <ul>
+   *                   <li>
+   *                      <p>A webhook triggers a build when the release name matches the
+   *                             regular expression <code>pattern</code>.</p>
+   *                      <note>
+   *                         <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p>
+   *                      </note>
+   *                   </li>
+   *                </ul>
+   *             </li>
    *          </ul>
    * @public
    */

codegen/sdk-codegen/aws-models/codebuild.json

@@ -8908,7 +8908,7 @@
         "type": {
           "target": "com.amazonaws.codebuild#WebhookFilterType",
           "traits": {
-            "smithy.api#documentation": "<p> The type of webhook filter. There are six webhook filter types: <code>EVENT</code>,\n                <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>,\n                <code>FILE_PATH</code>, and <code>COMMIT_MESSAGE</code>. </p>\n         <ul>\n            <li>\n               <p>\n                    EVENT\n                </p>\n               <ul>\n                  <li>\n                     <p> A webhook event triggers a build when the provided <code>pattern</code>\n                            matches one of six event types: <code>PUSH</code>,\n                            <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, \n                            <code>PULL_REQUEST_CLOSED</code>, \n                            <code>PULL_REQUEST_REOPENED</code>, and\n                            <code>PULL_REQUEST_MERGED</code>. The <code>EVENT</code> patterns are\n                            specified as a comma-separated string. For example, <code>PUSH,\n                                PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull\n                            request created, and pull request updated events. </p>\n                     <note>\n                        <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub\n                                Enterprise only. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>ACTOR_ACCOUNT_ID</p>\n               <ul>\n                  <li>\n                     <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n                            Bitbucket account ID matches the regular expression <code>pattern</code>.\n                        </p>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>HEAD_REF</p>\n               <ul>\n                  <li>\n                     <p> A webhook event triggers a build when the head reference matches the\n                            regular expression <code>pattern</code>. For example,\n                            <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p>\n                     <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n                            Enterprise pull request, Bitbucket push, and Bitbucket pull request events.\n                        </p>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>BASE_REF</p>\n               <ul>\n                  <li>\n                     <p> A webhook event triggers a build when the base reference matches the\n                            regular expression <code>pattern</code>. For example,\n                            <code>refs/heads/branch-name</code>. </p>\n                     <note>\n                        <p> Works with pull request events only. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>FILE_PATH</p>\n               <ul>\n                  <li>\n                     <p> A webhook triggers a build when the path of a changed file matches the\n                            regular expression <code>pattern</code>. </p>\n                     <note>\n                        <p> Works with GitHub and Bitbucket events push and pull requests events.\n                                Also works with GitHub Enterprise push events, but does not work with\n                                GitHub Enterprise pull request events. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>COMMIT_MESSAGE</p>\n               <ul>\n                  <li>\n                     <p>A webhook triggers a build when the head commit message matches the\n                            regular expression <code>pattern</code>.</p>\n                     <note>\n                        <p> Works with GitHub and Bitbucket events push and pull requests events.\n                                Also works with GitHub Enterprise push events, but does not work with\n                                GitHub Enterprise pull request events. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n         </ul>",
+            "smithy.api#documentation": "<p> The type of webhook filter. There are eight webhook filter types: <code>EVENT</code>,\n                <code>ACTOR_ACCOUNT_ID</code>, <code>HEAD_REF</code>, <code>BASE_REF</code>,\n            <code>FILE_PATH</code>, <code>COMMIT_MESSAGE</code>, <code>TAG_NAME</code>, and <code>RELEASE_NAME</code>. </p>\n         <ul>\n            <li>\n               <p>\n                    EVENT\n                </p>\n               <ul>\n                  <li>\n                     <p> A webhook event triggers a build when the provided <code>pattern</code>\n                            matches one of eight event types: <code>PUSH</code>,\n                            <code>PULL_REQUEST_CREATED</code>, <code>PULL_REQUEST_UPDATED</code>, \n                            <code>PULL_REQUEST_CLOSED</code>, <code>PULL_REQUEST_REOPENED</code>, \n                            <code>PULL_REQUEST_MERGED</code>, <code>RELEASED</code>, and <code>PRERELEASED</code>. The <code>EVENT</code> patterns are\n                            specified as a comma-separated string. For example, <code>PUSH,\n                                PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED</code> filters all push, pull\n                            request created, and pull request updated events. </p>\n                     <note>\n                        <p> The <code>PULL_REQUEST_REOPENED</code> works with GitHub and GitHub\n                                Enterprise only. The <code>RELEASED</code> and <code>PRERELEASED</code> work \n                                with GitHub only.</p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>ACTOR_ACCOUNT_ID</p>\n               <ul>\n                  <li>\n                     <p> A webhook event triggers a build when a GitHub, GitHub Enterprise, or\n                            Bitbucket account ID matches the regular expression <code>pattern</code>.\n                        </p>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>HEAD_REF</p>\n               <ul>\n                  <li>\n                     <p> A webhook event triggers a build when the head reference matches the\n                            regular expression <code>pattern</code>. For example,\n                            <code>refs/heads/branch-name</code> and <code>refs/tags/tag-name</code>. </p>\n                     <note>\n                        <p> Works with GitHub and GitHub Enterprise push, GitHub and GitHub\n                            Enterprise pull request, Bitbucket push, and Bitbucket pull request events.</p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>BASE_REF</p>\n               <ul>\n                  <li>\n                     <p> A webhook event triggers a build when the base reference matches the\n                            regular expression <code>pattern</code>. For example,\n                            <code>refs/heads/branch-name</code>. </p>\n                     <note>\n                        <p> Works with pull request events only. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>FILE_PATH</p>\n               <ul>\n                  <li>\n                     <p> A webhook triggers a build when the path of a changed file matches the\n                            regular expression <code>pattern</code>. </p>\n                     <note>\n                        <p> Works with GitHub and Bitbucket events push and pull requests events.\n                                Also works with GitHub Enterprise push events, but does not work with\n                                GitHub Enterprise pull request events. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>COMMIT_MESSAGE</p>\n               <ul>\n                  <li>\n                     <p>A webhook triggers a build when the head commit message matches the\n                            regular expression <code>pattern</code>.</p>\n                     <note>\n                        <p> Works with GitHub and Bitbucket events push and pull requests events.\n                                Also works with GitHub Enterprise push events, but does not work with\n                                GitHub Enterprise pull request events. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>TAG_NAME</p>\n               <ul>\n                  <li>\n                     <p>A webhook triggers a build when the tag name of the release matches the \n                            regular expression <code>pattern</code>.</p>\n                     <note>\n                        <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n            <li>\n               <p>RELEASE_NAME</p>\n               <ul>\n                  <li>\n                     <p>A webhook triggers a build when the release name matches the \n                            regular expression <code>pattern</code>.</p>\n                     <note>\n                        <p> Works with <code>RELEASED</code> and <code>PRERELEASED</code> events only. </p>\n                     </note>\n                  </li>\n               </ul>\n            </li>\n         </ul>",
             "smithy.api#required": {}
           }
         },