Skip to content

Commit

Permalink
Updates README and constrains GH pages to master only
Browse files Browse the repository at this point in the history
  • Loading branch information
adriancole committed Nov 22, 2020
1 parent 9061340 commit 33389ae
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,5 @@ jobs:
SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
run: | # GITHUB_REF will be refs/heads/master or refs/tags/N.M.L
build-bin/configure_deploy &&
build-bin/git/login_git &&
build-bin/deploy $(echo ${GITHUB_REF} | cut -d/ -f 3)
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Zipkin API

[![Gitter chat](http://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/openzipkin/zipkin)
[![Build Status](https://github.com/openzipkin/zipkin-api/workflows/test/badge.svg)](https://github.com/openzipkin/zipkin-api/actions?query=workflow%3Atest)
[![Maven Central](https://img.shields.io/maven-central/v/io.zipkin.proto3/zipkin-proto3.svg)](https://search.maven.org/search?q=g:io.zipkin.proto3%20AND%20a:zipkin-proto3)

Zipkin API includes service and model definitions used for
Zipkin-compatible services.

Expand All @@ -16,3 +20,13 @@ IDL files are languagage agnostic, there are no compilation instructions needed
* [/api/v2](./zipkin2-api.yaml) - Most recent and published [here](https://zipkin.io/zipkin-api/#/)

Take a look at the [example repository](https://github.com/openzipkin/zipkin-api-example) for how to use this.

## Artifacts
The proto artifact published is `zipkin-proto3` under the group ID `io.zipkin.proto3`

### Library Releases
Releases are at [Sonatype](https://oss.sonatype.org/content/repositories/releases) and [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.zipkin.proto3%22)

### Library Snapshots
Snapshots are uploaded to [Sonatype](https://oss.sonatype.org/content/repositories/snapshots) after
commits to master.
8 changes: 7 additions & 1 deletion build-bin/deploy
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ set -ue
# This script deploys a master or release version.
#
# See [README.md] for an explanation of this and how CI should use it.
version=${1:-master}

# deploy maven snapshot or release version
build-bin/maven/maven_deploy
build-bin/idl_to_gh_pages

# update GH pages on commit
if [ "${version}" = "master" ]; then
build-bin/idl_to_gh_pages
fi

0 comments on commit 33389ae

Please sign in to comment.