Skip to content
This repository was archived by the owner on May 13, 2022. It is now read-only.

Commit b059615

Browse files
author
Silas Davis
authored
Merge branch 'main' into custom-reactors-support
2 parents d562fb8 + b193c90 commit b059615

File tree

917 files changed

+150526
-25895
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

917 files changed

+150526
-25895
lines changed

.circleci/config.yml

-131
This file was deleted.

.gitattributes

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.pb.go linguist-generated
2+
yarn.lock linguist-generated

.github/CONTRIBUTING.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
# Contributing to `burrow`:
2-
Forked from Docker's [contributing guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md)
2+
Forked from Docker's [contributing guidelines](https://github.com/docker/docker/blob/main/CONTRIBUTING.md)
33

44
## Developer Certificate of Origin
55

66
Please always include "signed-off-by" in your commit message and note this constitutes a developer certification you are contributing a patch under Apache 2.0. Please find a verbatim copy of the Developer Certificate of Origin in this repository [here](.github/DEVELOPER_CERTIFICATE_OF_ORIGIN.md) or on [developercertificate.org](https://developercertificate.org/).
77

8+
## Branches and releases
9+
10+
All development happens on 'main'. Any other branches should be considered temporary and should have a corresponding pull request where they are the source to help keep track of them. Such branches can be marked WIP/draft.
11+
12+
There is a special branch called 'prereleae' that is solely used to trigger a build of the JS library and docker images with a special prerelease tag based on the commit hash. This can be triggered by force pushing to 'prerelease'. If you would like a prerelease build please ask a maintainer (via an issue or on https://chat.hyperledger.org/channel/burrow) to force push for you. Since this branch may be overwritten at any time it should never be the only home for durable changes.
13+
14+
Commits tagged with a 'v'-prefixed semver tag like `v0.11.1` are official releases and will trigger builds of binaries, JS library, and docker images in CI. We will try to make these regularly but will sometimes batch up a few changes and dependency upgrades (particularly Tendermint).
15+
816
## Bug Reporting
917

1018
A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it!
@@ -17,15 +25,15 @@ Our [ISSUE_TEMPLATE.md](ISSUE_TEMPLATE.md) will autopopulate the new issue.
1725

1826
## Contribution Tips and Guidelines
1927

20-
### Pull requests are always welcome (to `develop` rather than `master`).
28+
### Pull requests are always welcome (always based on the `main` branch)
2129

22-
Not sure if that typo is worth a pull request? Found a bug and know how to fix it? Do it! We will appreciate it. Any significant improvement should be documented as a GitHub issue or discussed in [The Marmot Den](https://slack.monax.io) Slack community prior to beginning.
30+
Not sure if that typo is worth a pull request? Found a bug and know how to fix it? Do it! We will appreciate it.
2331

2432
We are always thrilled to receive pull requests (and bug reports!) and we do our best to process them quickly.
2533

2634
## Conventions
2735

28-
Fork the repository and make changes on your fork in a feature branch (branched from develop), create an issue outlining your feature or a bug, or use an open one.
36+
Fork the repository and make changes on your fork in a feature branch, create an issue outlining your feature or a bug, or use an open one.
2937

3038
If it's a bug fix branch, name it something-XXXX where XXXX is the number of the issue.
3139
If it's a feature branch, create an enhancement issue to announce your intentions, and name it something-XXXX where XXXX is the number of the issue.
@@ -42,22 +50,16 @@ Commit messages must start with a short summary (max. 50 chars) written in the i
4250

4351
Code review comments may be added to your pull request. Discuss, then make the suggested modifications and push additional commits to your feature branch.
4452

45-
Pull requests must be cleanly rebased on top of develop without multiple branches mixed into the PR.
53+
Pull requests must be cleanly rebased on top of main without multiple branches mixed into the PR.
4654

47-
*Git tip:* If your PR no longer merges cleanly, use `git rebase develop` in your feature branch to update your pull request rather than merge develop.
48-
49-
Before you make a pull request, squash your commits into logical units of work using `git rebase -i` and `git push -f`. A logical unit of work is a consistent set of patches that should be reviewed together: for example, upgrading the version of a vendored dependency and taking advantage of its now available new feature constitute two separate units of work. Implementing a new function and calling it in another file constitute a single logical unit of work. The very high majority of submissions should have a single commit, so if in doubt: squash down to one.
55+
*Git tip:* If your PR no longer merges cleanly, use `git rebase main` in your feature branch to update your pull request rather than merge main.
5056

5157
After every commit, make sure the test suite passes. Include documentation changes in the same pull request so that a revert would remove all traces of the feature or fix.
5258

5359
### Merge approval
5460

5561
We use LGTM (Looks Good To Me) in commands on the code review to indicate acceptance.
5662

57-
## Errors and Log Messages Style
58-
59-
TODO
60-
6163
## Coding Style
6264

6365
Unless explicitly stated, we follow all coding guidelines from the Go community. While some of these standards may seem arbitrary, they somehow seem to result in a solid, consistent codebase.
@@ -68,7 +70,7 @@ It is possible that the code base does not currently comply with these guideline
6870
* All code should follow the guidelines covered in [Effective Go](https://golang.org/doc/effective_go.html) and [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments).
6971
* Comment the code. Tell us the why, the history and the context.
7072
* Document all declarations and methods, even private ones. Declare expectations, caveats and anything else that may be important. If a type gets exported, having the comments already there will ensure it's ready.
71-
* Variable name length should be proportional to it's context and no longer. noCommaALongVariableNameLikeThisIsNotMoreClearWhenASimpleCommentWouldDo. In practice, short methods will have short variable names and globals will have longer names.
73+
* Variable name length should be proportional to its context and no longer. noCommaALongVariableNameLikeThisIsNotMoreClearWhenASimpleCommentWouldDo. In practice, short methods will have short variable names and globals will have longer names.
7274
* No underscores in package names. If you need a compound name, step back, and re-examine why you need a compound name. If you still think you need a compound name, lose the underscore.
7375
* No utils or helpers packages. If a function is not general enough to warrant its own package, it has not been written generally enough to be a part of a `util` package. Just leave it unexported and well-documented.
7476
* All tests should run with `go test` and outside tooling should not be required. No, we don't need another unit testing framework. Assertion packages are acceptable if they provide real incremental value.

.circleci/Dockerfile .github/Dockerfile

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM golang:1.12.6-alpine3.10
1+
FROM golang:1.15-alpine3.13
22
MAINTAINER Monax <[email protected]>
33

44
ENV DOCKER_VERSION "17.12.1-ce"
@@ -7,7 +7,7 @@ ENV GORELEASER_VERSION "v0.104.1"
77
# Update remote with 'make push_ci_image'
88
RUN apk add --update --no-cache \
99
nodejs \
10-
npm \
10+
yarn \
1111
netcat-openbsd \
1212
git \
1313
openssh-client \
@@ -21,15 +21,13 @@ RUN apk add --update --no-cache \
2121
docker \
2222
libffi-dev \
2323
openssl-dev \
24-
python-dev \
24+
python3-dev \
2525
py-pip
26-
RUN pip install docker-compose
26+
RUN pip3 install docker-compose
2727
# get docker client
2828
WORKDIR /usr/bin
2929
RUN curl -sS -L https://download.docker.com/linux/static/stable/x86_64/docker-$DOCKER_VERSION.tgz | tar xz --strip-components 1 docker/docker
3030
RUN curl -sS -L https://github.com/goreleaser/goreleaser/releases/download/$GORELEASER_VERSION/goreleaser_Linux_x86_64.tar.gz | tar xz goreleaser
31-
RUN npm install -g mocha
32-
RUN npm install -g mocha-circleci-reporter
3331
ENV CI=true
3432
# Protobuf builds require being in GOPATH (more or less) but this disables module support by default
3533
ENV GO111MODULE=on

.github/ISSUE_TEMPLATE.md

-12
This file was deleted.

.github/ISSUE_TEMPLATE/bug-report.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the Bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior.
15+
16+
**Expected Behavior**
17+
A clear and concise description of what you expected to happen.
18+
19+
**Technical Details**
20+
- [ ] Burrow Version (docker image tag or branch if built from source)
21+
- [ ] Go Version (if applicable)
22+
- [ ] Docker Version (if applicable)
23+
- [ ] Operating System (osx/windows/linux)
24+
25+
**Additional Context**
26+
Add any other context about the problem here.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/workflows/main.yaml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: main
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
cover:
9+
name: coverage
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/setup-go@v1
13+
with:
14+
go-version: 1.15
15+
id: go
16+
- uses: actions/checkout@v2
17+
- run: make test
18+
env:
19+
GO_TEST_ARGS: "-coverprofile=coverage.txt -covermode=atomic"
20+
- uses: codecov/[email protected]
21+
with:
22+
token: ${{ secrets.CODECOV_TOKEN }}
23+
file: ./coverage.txt
24+
25+
docker:
26+
name: docker
27+
runs-on: ubuntu-latest
28+
steps:
29+
- uses: actions/checkout@v2
30+
- run: make docker_build
31+
- name: publish monax
32+
env:
33+
DOCKER_REPO: "hyperledger/burrow"
34+
DOCKER_REPO_DEV: "quay.io/monax/burrow"
35+
DOCKER_PASS_DEV: ${{ secrets.DOCKER_PASS_DEV }}
36+
DOCKER_USER_DEV: ${{ secrets.DOCKER_USER_DEV }}
37+
run: |
38+
version=$(./scripts/local_version.sh)
39+
echo ${DOCKER_PASS_DEV} | docker login --username ${DOCKER_USER_DEV} ${DOCKER_REPO_DEV} --password-stdin
40+
docker tag ${DOCKER_REPO}:${version} ${DOCKER_REPO_DEV}:${version}
41+
docker push --all-tags ${DOCKER_REPO_DEV}
42+
- name: publish hyperledger
43+
env:
44+
DOCKER_REPO: "hyperledger/burrow"
45+
DOCKER_PASS: ${{ secrets.DOCKER_PASS }}
46+
DOCKER_USER: ${{ secrets.DOCKER_USER }}
47+
run: |
48+
version=$(./scripts/local_version.sh)
49+
echo ${DOCKER_PASS} | docker login --username ${DOCKER_USER} --password-stdin
50+
docker tag ${DOCKER_REPO}:${version} ${DOCKER_REPO}:latest
51+
docker push ${DOCKER_REPO}:latest

0 commit comments

Comments
 (0)