EiffelSourceChangeCreatedEvent (SCC)

The EiffelSourceChangeCreatedEvent declares that a change to sources has been made, but not yet submitted (see EiffelSourceChangeSubmittedEvent). This can be used to represent a change done on a private branch, undergoing review or made in a forked repository. Unlike EiffelSourceChangeSubmittedEvent, EiffelSourceChangeCreatedEvent describes the change in terms of who authored it and which issues it addressed.

Where changes are integrated (or "submitted") directly on a shared branch of interest (e.g. "master", "dev" or "mainline") both EiffelSourceChangeCreatedEvent and EiffelSourceChangeSubmittedEvent are sent together.

Data Members

data.author

Type: Object
Required: No
Description: The author of the change.

data.author.name

Type: String
Required: No
Description: The name of the author.

data.author.email

Type: String
Required: No
Description: The email address of the author.

data.author.id

Type: String
Required: No
Description: Any identity, username or alias of the author.

data.author.group

Type: String
Required: No
Description: Any group or organization to which the contributor belongs.

data.change

Type: Object
Required: No
Description: A summary of the change.

data.change.insertions

Type: Integer
Required: No
Description: The number of inserted lines in the change.

data.change.deletions

Type: Integer
Required: No
Description: The number of deleted lines in the change.

data.change.files

Type: String
Required: No
Description: A URI to a list of files changed, on JSON String array format.

data.change.details

Type: String
Required: No
Description: A URI to further details about the change. These details are not assumed to be on any standardized format, and may be intended for human and/or machine consumption. Examples include e.g. Gerrit patch set descriptions or GitHub commit pages. It is recommended to also include data.change.tracker to provide a hint as to the nature of the linked details.

data.change.tracker

Type: String
Required: No
Description: The name of the tracker, if any, of the change. Examples include e.g. Gerrit or GitHub.

data.change.id

Type: String
Required: No
Description: The unique identity, if any, of the change (apart from what is expressed in the identifier object). Examples include e.g. Gerrit Change-Ids or GitHub Pull Requests. It is recommended to also include data.change.tracker to provide a hint as to the nature of the identity.

data.issues

Type: Object[]
Required: No
Description: A list of issues addressed by the change.

data.issues.type

Type: String
Required: Yes
Legal values: BUG, IMPROVEMENT, FEATURE, WORK_ITEM, REQUIREMENT, OTHER
Description: The type of issue.

data.issues.tracker

Type: String
Required: Yes
Description: The name of the issue tracker. This can unfortunately not be standardized, and is therefore context sensitive: though some trackers and ALM tools are more popular than others, an exhaustive enumeration is impossible, particularly when considering company specific internal solutions. Consequently one should not rely on the name as the primary method of retrieval, but rather data.issues.uri. data.issues.tracker together with data.issues.id is still useful for analysis and traceability, however, as long as it can be correctly interpreted.

data.issues.id

Type: String
Required: Yes
Description: The identity of the issue. This is tracker dependent - most trackers have their own issue naming schemes.

data.issues.uri

Type: String
Required: Yes
Description: The URI of the issue.

data.issues.transition

Type: String
Required: Yes
Legal values: RESOLVED, PARTIAL, REMOVED
Description: The new state of the issue: does the change resolve it, partially resolve it or remove it?

data.gitIdentifier

Type: Object
Required: No
Description: Identifier of a Git change.

data.gitIdentifier.commitId

Type: String
Required: Yes
Description: The commit identity (hash) of the change.

data.gitIdentifier.branch

Type: String
Required: No
Description: The name of the branch where the change was made.

data.gitIdentifier.repoName

Type: String
Required: No
Description: The name of the repository containing the change.

data.gitIdentifier.repoUri

Type: String
Required: Yes
Description: The URI of the repository containing the change.

data.svnIdentifier

Type: Object
Required: No
Description: Identifier of a Subversion change.

data.svnIdentifier.revision

Type: Integer
Required: Yes
Description: The revision of the change.

data.svnIdentifier.directory

Type: String
Required: Yes
Description: The directory (branch/tag) of the change.

data.svnIdentifier.repoName

Type: String
Required: No
Description: The name of the repository containing the change.

data.svnIdentifier.repoUri

Type: String
Required: Yes
Description: The URI of the repository containing the change.

data.ccCompositeIdentifier

Type: Object
Required: No
Description: Identifier of a composite ClearCase change – in other words, not single file commit, but analogous of repository-wide commits of e.g. SVN or Git.

data.ccCompositeIdentifier.vobs

Type: String[]
Required: Yes
Description: The names of the changed ClearCase VOBs.

data.ccCompositeIdentifier.branch

Type: String
Required: Yes
Description: The branch of the change.

data.ccCompositeIdentifier.configSpec

Type: String
Required: Yes
Description: The URI of the relevant ClearCase config spec.

data.hgIdentifier

Type: Object
Required: No
Description: Identifier of a Mercurial change.

data.hgIdentifier.commitId