Package io.github.cdklabs.projen.gitlab

Interface Artifacts

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    Artifacts.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.115Z")
@Stability(Experimental)
public interface Artifacts
extends software.amazon.jsii.JsiiSerializable
    (experimental) Used to specify a list of files and directories that should be attached to the job if it succeeds.

    Artifacts are sent to Gitlab where they can be downloaded.

    See Also:
    https://docs.gitlab.com/ee/ci/yaml/#artifacts

    • Method Summary

      All Methods Static Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      static Artifacts.Builder builder()  
      default List<String> getExclude()
      (experimental) A list of paths to files/folders that should be excluded in the artifact.
      default String getExpireIn()
      (experimental) How long artifacts should be kept.
      default String getExposeAs()
      (experimental) Can be used to expose job artifacts in the merge request UI.
      default String getName()
      (experimental) Name for the archive created on job success.
      default List<String> getPaths()
      (experimental) A list of paths to files/folders that should be included in the artifact.
      default Reports getReports()
      (experimental) Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests.
      default Boolean getUntracked()
      (experimental) Whether to add all untracked files (along with 'artifacts.paths') to the artifact.
      default CacheWhen getWhen()
      (experimental) Configure when artifacts are uploaded depended on job status.

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

        $jsii$toJson

    • Method Detail

      • getExclude

        @Stability(Experimental)
@Nullable
default List<String> getExclude()
        (experimental) A list of paths to files/folders that should be excluded in the artifact.

      • getExpireIn

        @Stability(Experimental)
@Nullable
default String getExpireIn()
        (experimental) How long artifacts should be kept.

        They are saved 30 days by default. Artifacts that have expired are removed periodically via cron job. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'.

      • getExposeAs

        @Stability(Experimental)
@Nullable
default String getExposeAs()
        (experimental) Can be used to expose job artifacts in the merge request UI.

        GitLab will add a link <expose_as> to the relevant merge request that points to the artifact.

      • getName

        @Stability(Experimental)
@Nullable
default String getName()
        (experimental) Name for the archive created on job success.

        Can use variables in the name, e.g. '$CI_JOB_NAME'

      • getPaths

        @Stability(Experimental)
@Nullable
default List<String> getPaths()
        (experimental) A list of paths to files/folders that should be included in the artifact.

      • getReports

        @Stability(Experimental)
@Nullable
default Reports getReports()
        (experimental) Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests.

      • getUntracked

        @Stability(Experimental)
@Nullable
default Boolean getUntracked()
        (experimental) Whether to add all untracked files (along with 'artifacts.paths') to the artifact.

      • getWhen

        @Stability(Experimental)
@Nullable
default CacheWhen getWhen()
        (experimental) Configure when artifacts are uploaded depended on job status.