Skip to content

Commit 126f190

Browse files
authoredFeb 23, 2023
ci: Remove Buf tokens from workflow (celestiaorg#378)
* ci: Remove Buf tokens from workflow Signed-off-by: Thane Thomson <[email protected]> * Format proto folder readme to trigger workflow Signed-off-by: Thane Thomson <[email protected]> --------- Signed-off-by: Thane Thomson <[email protected]>
1 parent 280f4b9 commit 126f190

File tree

2 files changed

+30
-16
lines changed

2 files changed

+30
-16
lines changed
 

‎.github/workflows/proto-lint.yml

-4
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@ jobs:
1616
steps:
1717
- uses: actions/checkout@v3
1818
- uses: bufbuild/buf-setup-action@v1.14.0
19-
with:
20-
github_token: ${{ secrets.BUF_GITHUB_API_TOKEN }}
21-
buf_api_token: ${{ secrets.BUF_API_TOKEN }}
2219
- uses: bufbuild/buf-lint-action@v1
2320
with:
2421
input: 'proto'
25-
buf_token: ${{ secrets.BUF_API_TOKEN }}

‎proto/README.md

+30-12
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,41 @@
11
# Protocol Buffers
22

3-
This sections defines the types and messages shared across implementations. The definition of the data structures are located in the [core/data_structures](../spec/core/data_structures.md) for the core data types and ABCI definitions are located in the [ABCI](../spec/abci/README.md) section.
3+
This sections defines the types and messages shared across implementations. The
4+
definition of the data structures are located in the
5+
[core/data\_structures](../spec/core/data_structures.md) for the core data types
6+
and ABCI definitions are located in the [ABCI](../spec/abci/README.md) section.
47

58
## Process of Updates
69

7-
The `.proto` files within this section are core to the protocol and updates must be treated as such.
10+
The `.proto` files within this section are core to the protocol and updates must
11+
be treated as such.
812

913
### Steps
1014

11-
1. Make an issue with the proposed change.
12-
- Within in the issue members from both the CometBFT and Tendermint-rs team will leave comments. If there is not consensus on the change an [RFC](../docs/rfc/README.md) may be requested.
13-
1a. Submission of an RFC as a pull request should be made to facilitate further discussion.
14-
1b. Merge the RFC.
15-
2. Make the necessary changes to the `.proto` file(s), [core data structures](../spec/core/data_structures.md) and/or [ABCI protocol](../spec/abci).
16-
3. Open issues within CometBFT and Tendermint-rs repos. This is used to notify the teams that a change occurred in the spec.
17-
1. Tag the issue with a spec version label. This will notify the team the changed has been made on master but has not entered a release.
15+
1. Make an issue with the proposed change. Within in the issue members from
16+
both the CometBFT and tendermint-rs team will leave comments. If there is not
17+
consensus on the change an [RFC](../docs/rfc/README.md) may be requested.
18+
1. Submission of an RFC as a pull request should be made to facilitate
19+
further discussion.
20+
2. Merge the RFC.
21+
2. Make the necessary changes to the `.proto` file(s), [core data
22+
structures](../spec/core/data_structures.md) and/or [ABCI
23+
protocol](../spec/abci).
24+
3. Open issues within CometBFT and Tendermint-rs repos. This is used to notify
25+
the teams that a change occurred in the spec.
26+
1. Tag the issue with a spec version label. This will notify the team the
27+
changed has been made on master but has not entered a release.
1828

1929
### Versioning
2030

21-
The spec repo aims to be versioned. Once it has been versioned, updates to the protobuf files will live on master. After a certain amount of time, decided on by CometBFT and tendermint-rs team leads, a release will be made on the spec repo. The spec may contain minor releases as well, depending on the implementation these changes may lead to a breaking change. If so, the implementation team should open an issue within the spec repo requiring a major release of the spec.
22-
23-
If the steps above were followed each implementation should have issues tagged with a spec change label. Once all issues have been completed the team should signify their readiness for release.
31+
The spec repo aims to be versioned. Once it has been versioned, updates to the
32+
protobuf files will live on master. After a certain amount of time, decided on
33+
by CometBFT and tendermint-rs team leads, a release will be made on the spec
34+
repo. The spec may contain minor releases as well, depending on the
35+
implementation these changes may lead to a breaking change. If so, the
36+
implementation team should open an issue within the spec repo requiring a major
37+
release of the spec.
38+
39+
If the steps above were followed each implementation should have issues tagged
40+
with a spec change label. Once all issues have been completed the team should
41+
signify their readiness for release.

0 commit comments

Comments
 (0)