https://github.com/prometheus/promu

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

circleci golang prometheus-utility

Last synced: 18 days ago
JSON representation

Prometheus Utility Tool

• Host: GitHub
• URL: https://github.com/prometheus/promu
• Owner: prometheus
• License: apache-2.0
• Created: 2016-04-08T07:40:18.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-05-02T18:19:17.000Z (12 months ago)
• Last Synced: 2024-05-08T17:23:37.631Z (12 months ago)
• Topics: circleci, golang, prometheus-utility
• Language: Go
• Size: 6.26 MB
• Stars: 259
• Watchers: 15
• Forks: 79
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

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