README
¶
Version Control/Git Service
This service uses gopkg.in/src-d/go-git.v4 git client
| Service Id | Action | Description | Request | Response |
|---|---|---|---|---|
| version/control | status | run version control check on provided URL | StatusRequest | Info |
| version/control | checkout | if target directory already exist with matching origin URL, this action only pulls the latest changes without overriding local ones, otherwise full checkout | CheckoutRequest | Info |
Usage
Checkout/pull
- Basic checkout
endly -r=checkout- @checkout.yaml
pipeline: checkout: action: vc/git:checkout origin: URL: https://github.com/src-d/go-git dest: URL: /tmp/foo - Private repo with basic auth
- endly -c=myacount
endly -r=checkout- @checkout.yaml
pipeline: checkout: action: vc/git:checkout origin: URL: https://github.com/myacount/myrepo.git credentials: myacount dest: URL: /tmp/myrepo - Private key based auth
endly -c=myacountpk -k=/path/key_rsawhere username is git and password is pharapraseendly -r=checkout- @checkout.yaml
pipeline: checkout: action: vc/git:checkout origin: URL: git@github.com/myacount/myrepo.git credentials: myrepopk dest: URL: /tmp/myrepo
Committing changes
- endly -c=myacount
endly -r=commit- @commit.yaml
init: target: URL: ssh://127.0.0.1 credentials: localhost pipeline: checkout: action: vc/git:checkout origin: URL: https://github.com/adrianwit/echo dest: URL: /tmp/echo update: action: exec:run target: $target commands: - echo ' ' >> /tmp/echo/app.go commit: action: vc/git:commit message: test commit credentials: git source: URL: /tmp/echo
Documentation
¶
Index ¶
Constants ¶
const ServiceID = "vc/git"
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CheckoutRequest ¶
type CheckoutRequest struct {
Origin *url.Resource `required:"true" description:"checkout source for git or svn or simply file::/path"`
Dest *url.Resource `required:"true" description:"checkout dest defined by host and path URL"`
Depth int
}
CheckoutRequest represents checkout request. If target directory exist and contains matching origin URL, only taking the latest changes without overriding local if performed, otherwise full checkout
func (*CheckoutRequest) Validate ¶
func (r *CheckoutRequest) Validate() error
Validate validates request
type CheckoutResponse ¶
type CheckoutResponse StatusResponse
CheckoutResponse represents checkout response
type CommitRequest ¶ added in v0.37.0
type CommitRequest struct {
Source *url.Resource `required:"true" description:"location to local source code"`
Message string `required:"true"`
Credentials string
}
CommitRequest represents a commit request
func (*CommitRequest) Init ¶ added in v0.37.0
func (r *CommitRequest) Init() error
Init initializes request
func (*CommitRequest) Validate ¶ added in v0.37.0
func (r *CommitRequest) Validate() error
Validate validates request
type CommitResponse ¶ added in v0.37.0
type CommitResponse struct {
*Info
}
CommitResponse represents a commit response
type Info ¶
type Info struct {
IsVersionControlManaged bool //returns true if directory is source controlled managed
Origin string //Origin URL
Revision string //Origin Revision
Branch string //current branch
IsUptoDate bool
Added []string //new files
Untracked []string //untracked files
Modified []string //modified files
Deleted []string //deleted files
}
Info represents version control info
func (*Info) HasPendingChanges ¶
HasPendingChanges returns true if there are any untracked, new, modified, deleted files.
type OutputEvent ¶
type OutputEvent struct {
*msg.OutputEvent
}
OutputEvent represents an output event
type StatusRequest ¶
StatusRequest represents version control status
func (*StatusRequest) Validate ¶
func (r *StatusRequest) Validate() error
Validate validates request
type StatusResponse ¶
type StatusResponse struct {
*Info
}
StatusResponse represents version control status response
Source Files