-
Notifications
You must be signed in to change notification settings - Fork 59
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added SourceChangeSubmitted documentation. #16
Merged
d-stahl-ericsson
merged 2 commits into
eiffel-community:topic-drop2
from
d-stahl-ericsson:topic-drop2-sourcechangesubmitted
Jun 14, 2016
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# EiffelSourceChangeSubmittedEvent | ||
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 __links.change__ to reference [EiffelSourceChangeCreatedEvent](./EiffelSourceChangeCreatedEvent.md). | ||
|
||
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](./EiffelSourceChangeCreatedEvent.md) 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](./EiffelSourceChangeCreatedEvent.md). | ||
|
||
#### data.submitter.name | ||
__Type:__ String | ||
__Required:__ No | ||
__Description:__ The name of the author. | ||
|
||
#### data.submitter.email | ||
__Type:__ String | ||
__Required:__ No | ||
__Description:__ The email address of the author. | ||
|
||
#### data.submitter.id | ||
__Type:__ String | ||
__Required:__ No | ||
__Description:__ Any identity, username or alias of the author. | ||
|
||
#### data.submitter.group | ||
__Type:__ String | ||
__Required:__ No | ||
__Description:__ Any group or organization to which the contributor belongs. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Better to use submitter then contributor. |
||
|
||
### 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 ClearCase VOB name. | ||
|
||
#### 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. | ||
|
||
## Examples | ||
* [Simple example](https://github.com/Ericsson/eiffel-examples/blob/master/events/EiffelSourceChangeSubmittedEvent/simple.json) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use submitter instead of author. 3 occurrences.