Package io.github.cdklabs.projen.github

Enum VersioningStrategy

java.lang.Object

java.lang.Enum<VersioningStrategy>

io.github.cdklabs.projen.github.VersioningStrategy

All Implemented Interfaces:

Serializable, Comparable<VersioningStrategy>

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.093Z")
@Stability(Experimental)
public enum VersioningStrategy
extends Enum<VersioningStrategy>

(experimental) The strategy to use when edits manifest and lock files.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	(experimental) - For apps, the version requirements are increased.
INCREASE	(experimental) Always increase the version requirement to match the new version.
INCREASE_IF_NECESSARY	(experimental) Increase the version requirement only when required by the new version.
LOCKFILE_ONLY	(experimental) Only create pull requests to update lockfiles updates.
WIDEN	(experimental) Relax the version requirement to include both the new and old version, when possible.

Method Summary

Modifier and Type	Method	Description
static VersioningStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VersioningStrategy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOCKFILE_ONLY

@Stability(Experimental)
public static final VersioningStrategy LOCKFILE_ONLY

(experimental) Only create pull requests to update lockfiles updates.

Ignore any new versions that would require package manifest changes.

AUTO

@Stability(Experimental)
public static final VersioningStrategy AUTO

(experimental) - For apps, the version requirements are increased.

• For libraries, the range of versions is widened.

WIDEN

@Stability(Experimental)
public static final VersioningStrategy WIDEN

(experimental) Relax the version requirement to include both the new and old version, when possible.

INCREASE

@Stability(Experimental)
public static final VersioningStrategy INCREASE

(experimental) Always increase the version requirement to match the new version.

INCREASE_IF_NECESSARY

@Stability(Experimental)
public static final VersioningStrategy INCREASE_IF_NECESSARY

(experimental) Increase the version requirement only when required by the new version.

Method Detail

values

public static VersioningStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (VersioningStrategy c : VersioningStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static VersioningStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null