Skip to content

Commit

Permalink
Restores OpenZipkin publishing configuration (#24) (#925)
Browse files Browse the repository at this point in the history
  • Loading branch information
adriancole authored Jun 14, 2019
1 parent 68d05d4 commit 5a17fc0
Show file tree
Hide file tree
Showing 521 changed files with 4,938 additions and 6,671 deletions.
38 changes: 13 additions & 25 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing to Apache Zipkin Brave (incubating)
# Contributing to Zipkin

If you would like to contribute code, fork this GitHub repository and
send a pull request on a branch other than `master`.
send a pull request (on a branch other than `master` or `gh-pages`).

When submitting code, please apply [Square Code Style](https://github.com/square/java-code-styles).
* If the settings import correctly, CodeStyle/Java will be named Square and use 2 space tab and indent, with 4 space continuation indent.
Expand All @@ -14,32 +14,20 @@ the terms of the [APLv2](LICENSE).
All files are released with the Apache 2.0 license.

If you are adding a new file it should have a header like below. This
can be automatically added by running `mvn com.mycila:license-maven-plugin:format`.
can be automatically added by running `./mvnw com.mycila:license-maven-plugin:format`.

```
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
/**
* Copyright 2019 The OpenZipkin Authors
*
* http://www.apache.org/licenses/LICENSE-2.0
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
```

## Contributor Agreement

Non-trivial change requires an Individual Contributor License Agreement
(ICLA). The ICLA applies to all Apache Software Foundation projects, and
is a one-time effort. If you have not yet filled an ICLA, download the [template](https://www.apache.org/licenses/icla.pdf).
After filling the form with your information print, sign, scan, and send
it in an email attachment to secretary@apache.org. You will get a
confirmation and end up on a [list we can check](http://people.apache.org/unlistedclas.html).
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ name: Feature Request
about: Please first, look at existing issues to see if the feature has been requested before.

---
Please first, look at [existing issues](https://github.com/apache/incubator-zipkin-brave/issues) to see if the feature has been requested before. If you don't find anything tell us what problem you’re trying to solve. Often a solution already exists! Don’t send pull requests to implement new features without first getting our support. Sometimes we leave features out on purpose to keep the project small.
Please first, look at [existing issues](https://github.com/openzipkin/brave/issues) to see if the feature has been requested before. If you don't find anything tell us what problem you’re trying to solve. Often a solution already exists! Don’t send pull requests to implement new features without first getting our support. Sometimes we leave features out on purpose to keep the project small.

**Feature:**
Description of the feature

**Rational**
Why this feature should be in zipkin
Why would this feature help others besides me?

**Example Scenario**
When will this be used by operators?
What use case is not practical to serve before this feature?

**Prior Art**
* Links to prior art
Expand Down
51 changes: 37 additions & 14 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,50 @@
# Default JDK is really old: 1.8.0_31; Trusty's is less old: 1.8.0_51
# https://docs.travis-ci.com/user/ci-environment/#Virtualization-environments
sudo: required
dist: trusty
# Run `travis lint` when changing this file to avoid breaking the build.

cache:
directories:
- $HOME/.m2

language: java

jdk:
- openjdk11
jdk: openjdk11

services:
- rabbitmq
before_install:
# allocate commits to CI, not the owner of the deploy key
- git config user.name "zipkinci"
- git config user.email "zipkinci+zipkin-dev@googlegroups.com"
# setup https authentication credentials, used by ./mvnw release:prepare
- git config credential.helper "store --file=.git/credentials"
- echo "https://$GH_TOKEN:@github.com" > .git/credentials

cache:
directories:
- $HOME/.m2
# Override default travis to use the maven wrapper; skip license on travis due to #1512
install: ./mvnw install -DskipTests=true -Dlicense.skip=true -Dmaven.javadoc.skip=true -B -V
script: ./travis/publish.sh

# Don't build release tags. This avoids publish conflicts because the version commit exists both on master and the release tag.
# See https://github.com/travis-ci/travis-ci/issues/1532
branches:
except:
- /^[0-9]/

# Override default travis to use the maven wrapper
install: ./mvnw install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
script: ./mvnw clean verify -B
env:
global:
# Ex. travis encrypt BINTRAY_USER=your_github_account
- secure: "H/206l5ui8qWnFNMxB974bT0LgrLi8OxMk1YVR1Ndpw7+7MqnEqYCWTLFgsCyQ2BWD2oYVJVf+zG5kwGvPqXkVR4T2h+CTCMNGgoAlpLKRwn39HcBBRHTQGJzdcm7dCTP0WKDwEySYofLJ2pO0KelBubXkhAEQfSa5QL81mhDa0="
# Ex. travis encrypt BINTRAY_KEY=xxx-https://bintray.com/profile/edit-xxx --add
- secure: "F3g7AuO9HOsHCT2i2XgquNE6GiIuLNGDEJOK3N825ZvacRgU+7x+CJ1pn3Gr0I3TCw3821fAvWpgIhGXL1+l7pFPnQvNfB19eHowJE3YiKsMI/TsJDuOmzx8Kx3poVqPVlzd4lQ78wZ3BpVxwox+k9dXgWjcxjSITzlLib+WJZo="
# Ex. travis encrypt GH_TOKEN=XXX-https://github.com/settings/tokens-XXX --add
- secure: "AZysKsH7uI8h+w3Pszdc/O2Q1smDj8Xkpl6qq31M0eDr8fdyF50tEkyK48GHilWGj904T9OD/xDH7VN1Xpm92KsYP3pc7/lwNXXXLpID2z6k4oH6dwSn4Rrf18PJOZSaLNyAo+zYIoHnc/tGv5vau6XdMcs8hO73cUXnqpKku/o="
# Ex. travis encrypt SONATYPE_USER=your_sonatype_account
- secure: "diMmYEeyqSr1rJlsLWz1cVjpYncFRTBFHd0pMeUWSk+nQqFu6EWaU4TZw/1ALZYDFe7e1OOcLyQxh7gE4OFUMoC9FHuDwdusvdd+H/PvIfjxXjU/w1bEkOa4S89v/Sx69DXZEDgEAmmGOQj0is6zNUvB3ybWF63vjTD8GOURUIk="
# Ex. travis encrypt SONATYPE_PASSWORD=your_sonatype_password
- secure: "L0ojowpsepOksZq9jHz2lI7Px9BZx5q5rxor+ziN1UuPEqJWBX9ssUY785mIBpr7HevQiHLpxrnVC42OGPzgbmXMeMqcg34h6uE4axCIKGJ16O5+3rpulQAXkXUTWCfrhsnozfqCO1exRXckjQ+6THOPUrBh3ZVN9ftS5eBZHfE="

notifications:
webhooks:
urls:
- https://webhooks.gitter.im/e/637e968b45032d16ee26
on_success: change
on_failure: always

services:
- rabbitmq
5 changes: 0 additions & 5 deletions DISCLAIMER

This file was deleted.

92 changes: 0 additions & 92 deletions Jenkinsfile

This file was deleted.

6 changes: 0 additions & 6 deletions NOTICE

This file was deleted.

27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[![Gitter chat](http://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/openzipkin/zipkin)
[![Build Status](https://builds.apache.org/view/Z/view/Zipkin/job/GH-incubator-zipkin/job/incubator-zipkin-brave/job/master/badge/icon)](https://builds.apache.org/view/Z/view/Zipkin/job/GH-incubator-zipkin/job/incubator-zipkin-brave/job/master/)
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.zipkin.brave/brave.svg)](https://search.maven.org/search?q=g:org.apache.zipkin.brave%20AND%20a:brave)
[![Build Status](https://travis-ci.org/openzipkin/brave.svg?branch=master)](https://travis-ci.org/openzipkin/brave)
[![Maven Central](https://img.shields.io/maven-central/v/io.zipkin.brave/brave.svg)](https://search.maven.org/search?q=g:io.zipkin.brave%20AND%20a:brave)

# Brave
Brave is a library used to capture latency information about distributed
operations. It reports this data to [Zipkin](https://zipkin.apache.org) as spans.
operations. It reports this data to [Zipkin](https://zipkin.io) as spans.

Zipkin is based on [Dapper](http://research.google.com/pubs/pub36356.html). Dapper (dutch) = Brave (english)... So, that's where the name comes from.

Expand All @@ -18,7 +18,7 @@ and add tags that describe them. This library also includes code that
parses `X-B3-TraceId` headers.

Most users won't write tracing code directly. Rather, they reuse instrumentation
others have written. Check our [instrumentation](instrumentation/) and [Zipkin's list](https://zipkin.apache.org/pages/existing_instrumentations.html)
others have written. Check our [instrumentation](instrumentation/) and [Zipkin's list](https://zipkin.io/pages/existing_instrumentations.html)
before rolling your own. Common tracing libraries like JDBC, Servlet
and Spring already exist. Instrumentation written here are tested and
benchmarked.
Expand All @@ -38,7 +38,7 @@ is to neither impact your projects' choices, nor subject your project
to dependency decisions made by others.

For example, even including a basic reporting library,
[zipkin-sender-urlconnection](https://github.com/apache/incubator-zipkin-reporter-java), Brave transitively includes no json,
[zipkin-sender-urlconnection](https://github.com/openzipkin/zipkin-reporter-java), Brave transitively includes no json,
logging, protobuf or thrift dependency. This means zero concern if your
application chooses a specific version of SLF4J, Gson or Guava.
Moreover, the entire dependency tree including basic reporting in json,
Expand All @@ -57,14 +57,13 @@ test versions ranges to reduce the impact of this. For example, we test
[gRPC](instrumentation/grpc) and [Kafka](instrumentation/kafka-clients) against multiple library versions.

## Artifacts
All artifacts publish to the group ID "org.apache.zipkin.brave". We use a common
All artifacts publish to the group ID "io.zipkin.brave". We use a common
release version for all components.
### Source Releases
Source Releases are uploaded to [Apache](https://dist.apache.org/repos/dist/release/incubator/zipkin/brave)
### Binary Releases
Binary Releases are uploaded to [Apache](https://repository.apache.org/service/local/staging/deploy/maven2) and synchronized to [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.zipkin.brave%22)
### Binary Snapshots
Binary Snapshots are uploaded to [Apache](https://repository.apache.org/content/repositories/snapshots/) after commits to master.

### Library Releases
Releases are uploaded to [Bintray](https://bintray.com/openzipkin/maven/zipkin) and synchronized to [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.zipkin.brave%22)
### Library Snapshots
Snapshots are uploaded to [JFrog](https://oss.jfrog.org/artifactory/oss-snapshot-local) after commits to master.
### Version alignments
When using multiple brave components, you'll want to align versions in
one place. This allows you to more safely upgrade, with less worry about
Expand All @@ -77,7 +76,7 @@ Ex. in your dependencies section, import the BOM like this:
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.apache.zipkin.brave</groupId>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-bom</artifactId>
<version>${brave.version}</version>
<type>pom</type>
Expand All @@ -91,7 +90,7 @@ Now, you can leave off the version when choosing any supported
instrumentation. Also any indirect use will have versions aligned:
```xml
<dependency>
<groupId>org.apache.zipkin.brave</groupId>
<groupId>io.zipkin.brave</groupId>
<artifactId>brave-instrumentation-okhttp3</artifactId>
</dependency>
```
Expand Down
Loading

0 comments on commit 5a17fc0

Please sign in to comment.