https://github.com/blockdaemon/bpm-cli
Mirror for https://gitlab.com/Blockdaemon/bpm-cli
https://github.com/blockdaemon/bpm-cli
Last synced: 4 months ago
JSON representation
Mirror for https://gitlab.com/Blockdaemon/bpm-cli
- Host: GitHub
- URL: https://github.com/blockdaemon/bpm-cli
- Owner: Blockdaemon
- License: apache-2.0
- Created: 2019-11-08T17:01:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T05:54:14.000Z (about 2 years ago)
- Last Synced: 2024-11-14T00:32:49.176Z (6 months ago)
- Language: Go
- Homepage:
- Size: 4.43 MB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# bpm
Blockchain Package Manager by [Blockdaemon](https://blockdaemon.com/). Deploy, maintain, and upgrade blockchain nodes on your own infrastructure.
Further reading:
* End-user documentation: https://cli.bpm.docs.blockdaemon.com/
* Developer documentation: https://sdk.bpm.docs.blockdaemon.com/
# Contributing
Pleaes use [conventional commits](https://www.conventionalcommits.org) for you commit messages. This will help us in the future to auto-generate changelogs.
New features should be developed in a branch and merged after a code review.
# Building from source
## Requirements
Make sure you have the following tools:
- [Go](https://golang.org/) is the main pogramming language. It needs to be installed
- [Docker](https://www.docker.com/) is used to run packages. It needs to installed and running
- [goreleaser](https://goreleaser.com/) is used to build binary packages. It needs to be installed
- [golangci-lint](https://github.com/golangci/golangci-lint) is used to do static code checks. It needs to be installed
- [GPG](https://gnupg.org/) is used to sign build artifacts. It needs to be installed
## Building during development
Make sure Docker is running, otherwise the tests will fail.
To build during development without creating a version or publishing binaries, run:
make dev-release
## Releasing a new version
Make sure Docker is running, otherwise the tests will fail.
You need the Blockdaemon release GPG key imported into your GPG keyring.
make version= release
`` needs to be a valid [semantic version](https://semver.org/). Do **not prefix with `v`**, the script does that automatically.
# Writing documentation
The documentation is built using [redoc](https://redocly.github.io/redoc/) which renders and openapi/swagger file. Most of the text is stored in the `docs/documentation.md` file.
In order to render the documentation locally while working on it, run:
make serve-docs
and navigate to http://localhost:8080 to see a live rendering of the documentation.