modulepackage
0.0.0-20240410104820-c033b77dfc62
Repository: https://github.com/ashwanthkumar/go-gocd.git
Documentation: pkg.go.dev
# README
go-gocd
Go Lang library to access GoCD API.
Usage
package main
import (
"github.com/ashwanthkumar/go-gocd"
)
func main() {
client := gocd.New("http://localhost:8153", "admin", "badger")
agents, err := client.GetAllAgents()
// ... do whatever you want with the agents
}
API Endpoints Pending
- Agents
- Get all Agents
- Get one Agent
- Update an Agent
- Disable Agent
- Delete an Agent
- Agent job run history
- Users
- Get all Users
- Get one user
- Create a user
- Update a user
- Delete a user
- Materials
- Get all Materials
- Get material modifications
- Notify SVN materials
- Notify git materials
- Backups
- Create a backup
- Pipeline Group
- Config listing
- Artifacts
- Get all Artifacts
- Get artifact file
- Get artifact directory
- Create artifact
- Append to artifact
- Pipelines
- Get pipeline instance
- Get pipeline status
- Pause a pipeline
- Unpause a pipeline
- Releasing a pipeline lock
- Scheduling pipelines
- Create a pipeline
- Delete a pipeline
- Stages
- Cancel Stage
- Get Stage instance
- Get stage history
- Jobs
- Get Scheduled Jobs
- Get Job history
- Properties
- Get all job Properties
- Get one property
- Get historical properties
- Create property
- Configurations
- List all modifications
- Get repository modification diff
- Get Configuration
- Create pipeline (Deprecated API)
- Feeds (will not support)
- Dashboard
- Get Dashboard
- Pipeline Config
- Get pipeline Configuration
- Edit Pipeline configuration
- Create Pipeline
- Environment Config
- Get all environments
- Get environment config
- Create an environment
- Update an environment
- Patch an environment
- Delete an environment
# Packages
No description provided by the author
# Functions
New GoCD Client.
# Structs
Agent Object.
DefaultClient entrypoint for GoCD.
EnvironmentConfig Object.
EnvironmentVariable Object.
Job definition used also by other elements like the pipeline and stages.
JobHistory - Represents an instance of a job from the past.
No description provided by the author
JobStateTransition - Represents an instance of StateTransition the job went through.
LinkInXML - <link rel="..." href="..."> tag.
Material represents a material (Can be Git, Mercurial, Perforce, Subversion, Tfs, Pipeline, SCM).
MaterialModification represents a modification done on a material configuration.
MaterialRevision is a given revision of a material.
Pagination is a structure used in several places when the gocd api paginates the results.
Pipeline Object.
PipelineBuildCause represent what triggered the build of the pipeline.
PipelineGroup Object.
PipelineHistoryPage represents a page of the history of run of a pipeline.
PipelineInstance represents a pipeline instance (for a given run).
PipelineStatus represents the status of a pipeline.
ScheduledJob instance.
ScheduledJobResource wrapper for resources > resource.
No description provided by the author
SimpleMessage is in general the structure returned by the POST queries sent to GoCD.
StageRun represent a stage run history event.
# Interfaces
Client interface that exposes all the API methods supported by the underlying Client.
# Type aliases
FreeSpace is required for GoCD API inconsistencies in agent free space scrape.