Skip to content

Commit

Permalink
Prepare release v1.0.0 and update CONTRIBUTING.md (jaegertracing#314)
Browse files Browse the repository at this point in the history
Signed-off-by: Joe Farro <[email protected]>
Signed-off-by: vvvprabhakar <[email protected]>
  • Loading branch information
tiffon authored Jan 18, 2019
1 parent 309ef24 commit b5ec9d4
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 7 deletions.
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Releases

## Next (unreleased)
## v1.0.0 (January 18, 2019)

### Enhancements

Expand All @@ -9,7 +9,7 @@
* This release establishes our commitment to the `uiEmbed=v0` API
* A big thanks to [@aljesusg](https://github.com/aljesusg) for getting this off the ground in [#263](https://github.com/jaegertracing/jaeger-ui/pull/263)! :tada:

* **Trace detail:** Add a TraceGraph to the TracePage ([@copa2](https://github.com/copa2) in [#276](https://github.com/jaegertracing/jaeger-ui/pull/276))
* **Trace detail:** Add a tree view (aka Trace Graph) to the TracePage ([@copa2](https://github.com/copa2) in [#276](https://github.com/jaegertracing/jaeger-ui/pull/276))

* Stability: Experimental – See [#293](https://github.com/jaegertracing/jaeger-ui/issues/293) for discussion.
* Big thanks to [@copa2](https://github.com/copa2) for the contribution! :tada:
Expand All @@ -23,6 +23,10 @@

* **Search:** Add popover and prevent submit if duration params are invalid ([#244](https://github.com/jaegertracing/jaeger-ui/issues/244)) ([@everett980](https://github.com/everett980) in [#291](https://github.com/jaegertracing/jaeger-ui/pull/291))

* **Trace comparison:** Add link to timeline view from comparison view and selection ([@everett980](https://github.com/everett980) in [#313](https://github.com/jaegertracing/jaeger-ui/pull/313))

* **Trace DAGs:** Add the ability to copy node data in the Trace Graph and Trace Comparison views ([@everett980](https://github.com/everett980) in [#312](https://github.com/jaegertracing/jaeger-ui/pull/312))

* **Menu configuration:** Ability to open additional menu links in same tab (Resolves [#275](https://github.com/jaegertracing/jaeger-ui/issues/275)) ([@zablvit](https://github.com/zablvit) in [#278](https://github.com/jaegertracing/jaeger-ui/pull/278))

### Fixes
Expand Down
27 changes: 23 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# How to Contribute to Jaeger
# How to contribute to Jaeger UI

We'd love your help!

Jaeger is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

We gratefully welcome improvements to documentation as well as to code.

# Certificate of Origin
# Certificate of origin

By contributing to this project you agree to the [Developer Certificate of Origin](https://developercertificate.org/) (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the [DCO](DCO) file for details.

## Making A Change
## Making a change

_Before making any significant changes, please [open an issue](https://github.com/jaegertracing/jaeger-ui/issues)._ Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.

Expand Down Expand Up @@ -108,7 +108,7 @@ git config --add alias.amend "commit -s --amend"
git config --add alias.c "commit -s"
```

# Style Guide
# Style guide

Prefer to use [flow](https://flow.org/) for new code.

Expand All @@ -117,3 +117,22 @@ We use [`prettier`](https://prettier.io/), an "opinionated" code formatter. It c
Then, most issues will be caught by the linter, which can be applied via `yarn eslint`.

Finally, we generally adhere to the [Airbnb Style Guide](https://github.com/airbnb/javascript), with exceptions as noted in our `.eslintrc`.

# Cutting a Jaeger UI release

1. Determine the version for the release.
* Follow [semver.org](https://semver.org) to determine the new version for Jaeger UI.
* Review all changes since the last release to determine how, if at all, any externally facing APIs are impacted. This includes, but is not limited to, the UI config and URL routes such as deep-linking and configuring the embedded mode.
* Preface the version with a "v", e.g. `v1.0.0`.
1. Create and merge, per approval, a PR which preps the release.
1. The PR title should match the format "Preparing release vX.Y.Z".
1. CHANGELOG.md
* Change the version of the current release from "Next (unreleased)" to "vX.Y.Z (Month D, YYYY)" where "vX.Y.Z" is the semver for this release.
* Make sure all relevant changes made since the last release are present and listed under the current release. [`scripts/get-changelog.js`](https://github.com/jaegertracing/jaeger-ui/blob/52780c897f21131472de9b81c96ebd63853917ee/scripts/get-changelog.js) might be useful.
* If necessary, add a note detailing any impact to externally facing APIs.
1. Update `packages/jaeger-ui/package.json#version` to refer to the version being released.
1. Create a GitHub release.
* The tag and release must refer to the commit created when the PR from the previous step was merged.
* The tag name for the GitHub release should be the version for the release. It should include the "v", e.g. `v1.0.0`.
* The title of the release match the format "Jaeger UI vX.Y.Z".
* Copy the new CHANGELOG.md section into the release notes.
2 changes: 1 addition & 1 deletion packages/jaeger-ui/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"private": true,
"name": "jaeger-ui",
"version": "0.0.1",
"version": "1.0.0",
"main": "src/index.js",
"license": "Apache-2.0",
"homepage": ".",
Expand Down

0 comments on commit b5ec9d4

Please sign in to comment.