Skip to content

Commit

Permalink
Add push to buf schema registry
Browse files Browse the repository at this point in the history
  • Loading branch information
gi-wg2 committed Oct 20, 2023
1 parent fce2297 commit a56da28
Showing 1 changed file with 25 additions and 11 deletions.
36 changes: 25 additions & 11 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## Setup required to release/deploy from local machine:

See [our internal wiki](https://github.com/omnicate/loltel/wiki/Public-APIs#releasing-to-the-maven-central-repository) for the required local tooling/setup for releasing to the maven central repository.
See [our internal wiki](https://github.com/omnicate/loltel/wiki/Public-APIs#releasing-to-the-maven-central-repository)
for the required local tooling/setup for releasing to the maven central repository.

## Java/Maven artifacts

Expand All @@ -24,6 +25,7 @@ next version before a release:
```bash
./mvnw build-helper:parse-version versions:set -DnewVersion=ASPARAGUS-SNAPSHOT versions:commit --file wgtwo/pom-vX.xml
```

Replace "`ASPARAGUS`" with the desired x.y.z version number.
Also replace "vX" with v0 or v1 depending on which version of the api you need to target.

Expand All @@ -43,7 +45,8 @@ Also replace "vX" with v0 or v1 depending on which version of the api you need t

### Troubleshooting

If you get an error about "gpg: signing failed: Inappropriate ioctl for device", run these commands in your shell and try again:
If you get an error about "gpg: signing failed: Inappropriate ioctl for device", run these commands in your shell and
try again:

```
GPG_TTY=$(tty)
Expand All @@ -60,19 +63,27 @@ now been pushed to github so you'll have to edit the history and do a force push
1. delete the tag created by maven locally: `git tag -d $TAG`
2. delete the tag on the remote: `git push --delete $REMOTE $TAG`

## Protobuf FileDescriptorSet release
## Build and release protobuf artifacts

This requires that you have `buf` installed. See note below.
### Build FileDescriptorSet

1. `buf build -o image.bin`
```shell
buf build -o image.bin
```

## Go release
### Generate Go code

This requires that you have `buf` and the Go protoc plugins installed. See note below.
```shell
buf build -o image.bin
buf generate
```

We do include generated go code as part of this repo, which is generated by Buf
### Push to Buf Schema Registry

1. `buf generate`
```shell
buf registry login buf.build --username 'your username'
buf push
```

## Required tooling

Expand All @@ -87,6 +98,9 @@ If `rtx` is installed, the required tooling should be automatically picked up fr

## NPM package

The release for the Node.js Package Manager so far only contains the .proto files, since the other contents of the origin repository are not relevant for this type of packaging.
The release for the Node.js Package Manager so far only contains the .proto files, since the other contents of the
origin repository are not relevant for this type of packaging.

The package is available both on the [Github Registry](https://github.com/orgs/working-group-two/packages?repo_name=wgtwoapis) and on [NPMJS](https://www.npmjs.com/package/@working-group-two/wgtwoapis).
The package is available both on
the [Github Registry](https://github.com/orgs/working-group-two/packages?repo_name=wgtwoapis) and
on [NPMJS](https://www.npmjs.com/package/@working-group-two/wgtwoapis).

0 comments on commit a56da28

Please sign in to comment.