Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prometheus/promu

Prometheus Utility Tool
https://github.com/prometheus/promu

circleci golang prometheus-utility

Last synced: about 1 month ago
JSON representation

Prometheus Utility Tool

Awesome Lists containing this project

README

        

# Prometheus Utility Tool [![CircleCI](https://circleci.com/gh/prometheus/promu/tree/master.svg?style=shield)][circleci]

## Usage

```help
usage: promu [] [ ...]

promu is the utility tool for building and releasing Prometheus projects

Flags:
-h, --[no-]help Show context-sensitive help (also try --help-long and --help-man).
-c, --config=".promu.yml" Path to config file
-v, --[no-]verbose Verbose output

Commands:
help [...]
Show help.

build [] [...]
Build a Go project

check licenses [] [...]
Inspect source files for each file in a given directory

check changelog []
Check that CHANGELOG.md follows the guidelines

checksum [...]
Calculate the SHA256 checksum for each file in the given location

codesign
Code sign the darwin binary using rcodesign.

crossbuild [] []
Crossbuild a Go project using Golang builder Docker images

info
Print info about current project and exit

release [] [...]
Upload all release files to the Github release

tarball [] [...]
Create a tarball from the built Go project

version []
Print the version and exit
```

## `.promu.yml` config file

See documentation example [here](doc/examples/prometheus/.promu.yml)

## Compatibility

* Go 1.14+

## More information

* This tool is part of our reflection about [Prometheus component Builds](https://docs.google.com/document/d/1Ql-f_aThl-2eB5v3QdKV_zgBdetLLbdxxChpy-TnWSE)
* All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers) and the `#prometheus` channel on `irc.freenode.net`.

## Contributing

Refer to [CONTRIBUTING.md](CONTRIBUTING.md)

## License

Apache License 2.0, see [LICENSE](LICENSE).

[circleci]: https://circleci.com/gh/prometheus/promu