https://github.com/codacy/pulse-event-cli
Command line interface to push events to the pulse service
https://github.com/codacy/pulse-event-cli
accelerate devops engineering metrics
Last synced: 6 months ago
JSON representation
Command line interface to push events to the pulse service
- Host: GitHub
- URL: https://github.com/codacy/pulse-event-cli
- Owner: codacy
- License: apache-2.0
- Created: 2020-10-16T11:44:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-03T13:04:12.000Z (over 1 year ago)
- Last Synced: 2025-04-20T11:43:58.802Z (6 months ago)
- Topics: accelerate, devops, engineering, metrics
- Language: Go
- Homepage: https://pulse.codacy.com
- Size: 108 KB
- Stars: 1
- Watchers: 8
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Pulse Events CLI
This is a command-line interface to push events to [Pulse](https://pulse.codacy.com).
Take a look at Pulse's documentation [here](https://docs.pulse.codacy.com).
## Requirements
- git >= 1.8.x
## GitHub Action
You can find Pulse's Github-Action in Github's [marketplace](https://github.com/marketplace/actions/pulse-events-cli).
## Usage
For a detailed list of all commands/flags use:
```
./pulse-event-cli --help
```
### Push single events
#### Deployments
```sh
./pulse-event-cli push deployment \
--api-key "" \
--identifier 1.0.1 \
--timestamp 1602852032 \
--teams mercury,jupiter \
d7c1baaa0975a0e3577dad1c4c2368d3dd4f33b5 6ccff2820ff356b609d8a000e082af866d144cc8
```
#### Changes
```sh
./pulse-event-cli push change \
--api-key "" \
--identifier d7c1baaa0975a0e3577dad1c4c2368d3dd4f33b5 \
--timestamp 1602852032
```
#### Incidents
```sh
./pulse-event-cli push incident \
--api-key "" \
--identifier d7c1baaa0975a0e3577dad1c4c2368d3dd4f33b5 \
--timestampCreated 1602852032 \
--timestampResolved 1602852033
```
### Git helper
#### Deployments + changes
This will push the deployment and all commits from `` to the `HEAD` of the repo.
```sh
./pulse-event-cli push git deployment \
--previous-deployment-ref="" \
--api-key "" \
--identifier 1.0.1 \
--timestamp `date +%s` \
--teams mercury,jupiter
```
### Detected environments
Currently the CLI detects CI environments where data is being sent from.
We're collecting this information to improve the support on how we collect the metrics.
If your CI environment is not in this list,
contact to let us know about it.
Supported environments:
- appveyor
- aws-codebuild
- azure-pipelines
- bitrise
- buddy
- buildkite
- circleci
- codefresh
- codemagic
- codeship
- docker
- drone
- github-actions
- gitlab-ci
- gocd
- google-cloud-build
- greenhouse
- heroku-ci
- jenkins
- jfrog-pipelines
- magnum
- semaphore
- shippable
- solano
- teamcity
- travis
- wercker
## Build
```sh
go build
```
## Release
```sh
goreleaser --rm-dist
```