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.
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.
Type: String
Required: No
Description: The name of the submitter.
Type: String
Required: No
Description: The email address of the submitter.
Type: String
Required: No
Description: Any identity, username or alias of the submitter.
Type: String
Required: No
Description: Any group or organization to which the submitter belongs.
Type: Object
Required: No
Description: Identifier of a Git change.
Type: String
Required: Yes
Description: The commit identity (hash) of the change.
Type: String
Required: No
Description: The name of the branch where the change was made.
Type: String
Required: No
Description: The name of the repository containing the change.
Type: String
Required: Yes
Description: The URI of the repository containing the change.
Type: Object
Required: No
Description: Identifier of a Subversion change.
Type: Integer
Required: Yes
Description: The revision of the change.
Type: String
Required: Yes
Description: The directory (branch/tag) of the change.
Type: String
Required: No
Description: The name of the repository containing the change.
Type: String
Required: Yes
Description: The URI of the repository containing the change.
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.
Type: String[]
Required: Yes
Description: The names of the changed ClearCase VOBs.
Type: String
Required: Yes
Description: The branch of the change.
Type: String
Required: Yes
Description: The URI of the relevant ClearCase config spec.
Type: Object
Required: No
Description: Identifier of a Mercurial change.
Type: String
Required: Yes
Description: The commit identity (hash) of the change.
Type: String
Required: No
Description: The branch of the change.
Type: String
Required: No
Description: The name of the repo.
Type: String
Required: Yes
Description: The URI of the repo.
Required: No
Legal targets: EiffelSourceChangeCreatedEvent
Multiple allowed: No
Description: Identifies the change that was submitted.
Required: No
Legal targets: EiffelSourceChangeSubmittedEvent
Multiple allowed: Yes
Description: Identifies a latest previous version (there may be more than one in case of merges) of the submitted source change.
Required: No
Legal targets: Any
Multiple allowed: Yes
Description: Identifies a cause of the event occurring. SHOULD not be used in conjunction with CONTEXT: individual events providing CAUSE within a larger context gives rise to ambiguity. It is instead recommended to let the root event of the context declare CAUSE.
Required: No
Legal targets: EiffelActivityTriggeredEvent,
EiffelTestSuiteStartedEvent
Multiple allowed: No
Description: Identifies the activity or test suite of which this event constitutes a part.
Required: No
Legal targets: EiffelFlowContextDefinedEvent
Multiple allowed: Yes
Description: Identifies the flow context of the event: which is the continuous integration and delivery flow in which this occurred – e.g. which product, project, track or version this is applicable to.
Type: String
Format: UUID
Required: Yes
Description: The unique identity of the event, generated at event creation.
Type: String
Format: An event type name
Required: Yes
Description: The type of event. This field is required by the recipient of the event, as each event type has a specific meaning and a specific set of members in the data and links objects.
Type: String
Format: Semantic Versioning 2.0.0
Required: Yes
Description: The version of the event type. This field is required by the recipient of the event to interpret the contents. Please see Versioning for more information.
Type: Integer
Format: UNIX Epoch time, in milliseconds.
Required: Yes
Description: The event creation timestamp.
Type: String[]
Format: Free text
Required: No
Description: Any tags or keywords associated with the events, for searchability purposes.
Type: Object
Format:
Required: No
Description: A description of the source of the event. This object is primarily for traceability purposes, and while optional, some form of identification of the source is HIGHLY RECOMMENDED. It offers multiple methods of identifying the source of the event, techniques which may be select from based on the technology domain and needs in any particular use case.
Type: String
Format: Free text
Required: No
Description: Identifies the domain that produced an event. A domain is an infrastructure topological concept, which may or may not corresponds to an organization or product structures. A good example would be Java packages notation, ex. com.mycompany.product.component or mycompany.site.division. Also, keep in mind that all names are more or less prone to change. Particularly, it is recommended to avoid organizational names or site names, as organizations tend to be volatile and development is easily relocated. Relatively speaking, product and component names tend to be more stable and are therefore encouraged, while code names may be an option. You need to decide what is the most sensible option in your case.
Type: String
Format: Hostname
Required: No
Description: The hostname of the event sender.
Type: String
Format: Free text
Required: No
Description: The name of the event sender.
Type: String
Format: purl specification
Required: No
Description: The identity of the serializer software used to construct the event, in purl format.
Type: String
Format: URI
Required: No
Description: The URI of, related to or describing the event sender.
Type: Object
Format:
Required: No
Description: An optional object for enclosing security related information, particularly supporting data integrity. See Security for further information.
Type: String
Format: Distinguished Name
Required: Yes
Description: The identity of the author of the event. This property is intended to enable the recipient to identify the author of the event contents and/or look up the appropriate public key for decrypting the meta.security.integrityProtection.signature value and thereby verifying author identity and data integrity.
Type: Object
Format:
Required: No
Description: An optional object for enabling information integrity protection via cryptographic signing. To generate a correct meta.security.integrityProtection object:
- Generate the entire event, but with the meta.security.integrityProtection.signature value set to an empty string.
- Serialize the event on Canonical JSON Form.
- Generate the signature using the meta.security.integrityProtection.alg algorithm.
- Set the meta.security.integrityProtection.signature value to the resulting signature while maintaining Canonical JSON Form. To verify the integrity of the event, the consumer then resets meta.security.integrityProtection.signature to an empty string and ensures Canonical JSON Form before verifying the signature.
Type: String
Format: A valid JWA RFC 7518 alg parameter value, excluding "none"
Required: Yes
Description: The cryptographic algorithm used to digitally sign the event. If no signing is performed, the meta.security.integrityProtection SHALL be omitted rather than setting meta.security.integrityProtection.alg to "none".
Type: String
Format:
Required: Yes
Description: The signature produced by the signing algorithm.
Type: String
Format:
Required: No
Description: The producer of the event may include the relevant public key for convenience, rather than relying a separate key distribution mechanism. Note that this property, along with the rest of the event, is encompassed by the integrity protection offered via meta.security.integrityProtection.
Type: Object[]
Format:
Required: No
Description: An optional object for enabling verification of intact event sequences in a distributed environment, thereby protecting against data loss, race conditions and replay attacks. It allows event publishers to state the order in which they produce a certain set of events. In other words, it cannot provide any global guarantees as to event sequencing, but rather per-publisher guarantees. Every object in the array represents a named sequence of which this event forms a part. For every event including a given named sequence, the publisher SHALL increment meta.security.sequenceProtection.position by 1. The first event produced in a given named sequence SHALL numbered 1.
Type: String
Format:
Required: Yes
Description: The name of the sequence. There MUST not be two identical meta.security.sequenceProtection.sequenceName values in the same event.
Type: Integer
Format:
Required: Yes
Description: The number of the event within the named sequence.
| Version | Introduced in | Changes |
|---|---|---|
| 3.0.0 | edition-agen | Improved information integrity protection |
| 2.0.0 | dc5ec6f | Introduced purl identifiers instead of GAVs (see Issue 182) |
| 1.1.0 | edition-toulouse | Multiple links of type FLOW_CONTEXT allowed. |
| 1.0.0 | edition-bordeaux | Initial version. |