Skip to content

Latest commit

 

History

History
152 lines (120 loc) · 5.36 KB

EiffelSourceChangeSubmittedEvent.md

File metadata and controls

152 lines (120 loc) · 5.36 KB
Raw

EiffelSourceChangeSubmittedEvent (SCS)

The EiffelSourceChangeSubmittedEvent declares that a change has been integrated into to a shared source branch of interest (e.g. "master", "dev" or "mainline") as opposed to a private or local branch. Note that it does not describe what has changed, but instead uses the CHANGE link type to reference EiffelSourceChangeCreatedEvent.

Typical use cases for EiffelSourceChangeSubmittedEvent is to signal that a patch has passed code review and been submitted or that a feature/topic/team branch has been merged into the mainline/trunk/master. Where changes are made directly on the mainline, it is recommended to send both EiffelSourceChangeCreatedEvent and EiffelSourceChangeSubmittedEvent together for information completeness.

Even though multiple types of identifiers are available (see below), the event SHOULD include one and SHALL not include more than one; changes to multiple repositories are represented by multiple events.

Data Members

data.submitter

Type: Object
Required: No
Description: The agent (individual, group or machine) submitting the change. This is crucially different from the data.author field of EiffelSourceChangeCreatedEvent.

data.submitter.name

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

data.submitter.email

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

data.submitter.id

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

data.submitter.group

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

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.vob

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

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

data.hgIdentifier.branch

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

data.hgIdentifier.repoName

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

data.hgIdentifier.repoUri

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

Version History

Version Introduced in Changes
1.0.0 edition-bordeaux Initial version.

Examples