Package io.github.cdklabs.projen.github

Class GitHubActionsProvider

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.070Z")
@Stability(Experimental)
public class GitHubActionsProvider
extends software.amazon.jsii.JsiiObject
    (experimental) Manage the versions used for GitHub Actions used in steps.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

        software.amazon.jsii.JsiiObject.InitializationMode

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String get​(String action)
      (experimental) Resolve an action name to the version that should be used, taking into account any overrides.
      void set​(String action, String override)
      (experimental) Define an override for a given action.

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • GitHubActionsProvider

        protected GitHubActionsProvider​(software.amazon.jsii.JsiiObjectRef objRef)

      • GitHubActionsProvider

        protected GitHubActionsProvider​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • GitHubActionsProvider

        @Stability(Experimental)
public GitHubActionsProvider()

    • Method Detail

      • get

        @Stability(Experimental)
@NotNull
public String get​(@NotNull
                  String action)
        (experimental) Resolve an action name to the version that should be used, taking into account any overrides.

        Parameters:
        action - This parameter is required.

      • set

        @Stability(Experimental)
public void set​(@NotNull
                String action,
                @NotNull
                String override)
        (experimental) Define an override for a given action.

        Specify the action name without a version to override all usages of the action. You can also override a specific action version, by providing the version string. Specific overrides take precedence over overrides without a version.

        If an override for the same action name is set multiple times, the last override is used.

        Example: 

         // Force any use of `actions/checkout` to use a pin a specific commit
 project.github.actions.set("actions/checkout", "actions/checkout@aaaaaa");
 // But pin usage of `v3` to a different commit
 project.github.actions.set("actions/checkout@v3", "actions/checkout@ffffff");

        Parameters:
        action - This parameter is required.
        override - This parameter is required.