chore: Link to spec versioning doc (#1737)

Author: dyladan

README.md

@@ -58,6 +58,10 @@ This is the JavaScript version of [OpenTelemetry](https://opentelemetry.io/), a
 |             | 0.12.x       | 0.11.x                  |
 |             | 0.11.x       | 0.10.x                  |
 
+## Versioning
+
+The current version for each package can be found in the respective `package.json` file for that module. For additional details see the [versioning and stability][spec-versioning] document in the specification.
+
 ## Quick start
 
 ### Application Owner
@@ -434,3 +438,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [otel-contrib-instrumentation-document-load]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/web/opentelemetry-instrumentation-document-load
 [otel-contrib-instrumentation-hapi]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-hapi
 [otel-contrib-instrumentation-koa]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/master/plugins/node/opentelemetry-instrumentation-koa
+
+[spec-versioning]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md

RELEASING.md

@@ -1,10 +1,10 @@
-# Releasing OpenTelemetry Packages (for Maintainers Only)
+# Releasing OpenTelemetry Packages
 
 This document explains how to publish all OT modules at version x.y.z. Ensure that you’re following semver when choosing a version number.
 
 Release Process:
 
-- [Releasing OpenTelemetry Packages (for Maintainers Only)](#releasing-opentelemetry-packages-for-maintainers-only)
+- [Release Process (Maintainers only)](#release-process)
   - [Update to latest locally](#update-to-latest-locally)
   - [Create a new branch](#create-a-new-branch)
   - [Prepare each package for release](#prepare-each-package-for-release)
@@ -19,29 +19,31 @@ Release Process:
   - [Update CHANGELOG](#update-changelog)
   - [Known Issues](#known-issues)
 
-## Update to latest locally
+## Release Process
+
+### Update to latest locally
 
 Use `git fetch` and `git checkout origin/main` to ensure you’re on the latest commit. Make sure you have no unstaged changes. Ideally, also use `git clean -dfx` to remove all ignored and untracked files.
 
-## Create a new branch
+### Create a new branch
 
 Create a new branch called `x.y.z-proposal` from the current commit.
 
-## Prepare each package for release
+### Prepare each package for release
 
 Decide on the next `major.minor.patch` release number based on [semver](http://semver.org/) guidelines.
 
 - Use `npm install` command to initialize all package directories
 - Use `lerna publish --skip-npm --no-git-tag-version --no-push` to bump the version in all `package.json`
 - Use `npm run bootstrap` to generate latest `version.ts` files
 
-## Use the Changelog to create a GitHub Release
+### Use the Changelog to create a GitHub Release
 
-### Generate the changelog with lerna
+#### Generate the changelog with lerna
 
 Since we use `lerna`, we can use [lerna-changelog](https://github.com/lerna/lerna-changelog#lerna-changelog)
 
-#### How to use
+##### How to use
 
 Pass your [github token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) to generate the changelog automatically.
 For security reasons, when you create a Github token, select the permissions: under **repo**, select **Access public repositories**, **Access commit status**.
@@ -55,15 +57,15 @@ GITHUB_AUTH=<your token> lerna-changelog
 It will print something like:
 
 ```md
-## Unreleased (2018-05-24)
+### Unreleased (2018-05-24)
 
-#### :bug: Bug Fix
+##### :bug: Bug Fix
 * [#198](https://github.com/my-org/my-repo/pull/198) Avoid an infinite loop ([@helpful-hacker](https://github.com/helpful-hacker))
 
-#### :house: Internal
+##### :house: Internal
 * [#183](https://github.com/my-org/my-repo/pull/183) Standardize error messages ([@careful-coder](https://github.com/careful-coder))
 
-#### Commiters: 2
+##### Commiters: 2
 - Helpful Hacker ([@helpful-hacker](https://github.com/helpful-hacker))
 - [@careful-coder](https://github.com/careful-coder)
 ```
@@ -76,21 +78,21 @@ You can also use the `--from` and `--to` options to view a different range of pu
 GITHUB_AUTH=xxxxx lerna-changelog --from=v1.0.0 --to=v2.0.0
 ```
 
-#### Update Changelog file
+##### Update Changelog file
 
 From what `lerna-changelog` has generated, starts new Unreleased label. Follow the example set by recent Released label.
 
 On [GitHub Releases](https://github.com/open-telemetry/opentelemetry-js/releases), follow the example set by recent releases to populate a summary of changes, as well as a list of commits that were applied since the last release. Save it as a draft, don’t publish it. Don’t forget the tag -- call it `vx.y.z` and leave it pointing at `main` for now (this can be changed as long as the GitHub release isn’t published).
 
-## Create a new PR
+### Create a new PR
 
 Create a pull request titled `chore: x.y.z release proposal`. The commit body should just be a link to the draft notes. Someone who can access draft notes should approve it, looking in particular for test passing, and whether the draft notes are satisfactory.
 
-## Merge and pull
+### Merge and pull
 
 Merge the PR, and pull the changes locally (using the commands in the first step). Ensure that `chore: x.y.z release proposal` is the most recent commit.
 
-## Publish all packages
+### Publish all packages
 
 Go into each directory and use `npm publish` (requires permissions) to publish the package. You can use the following script to automate this.
 
@@ -106,16 +108,16 @@ done
 
 Check your e-mail and make sure the number of “you’ve published this module” emails matches the number you expect.
 
-## Publish the GitHub Release
+### Publish the GitHub Release
 
 Publish the GitHub release, ensuring that the tag points to the newly landed commit corresponding to release proposal `x.y.z`.
 
-## Update CHANGELOG
+### Update CHANGELOG
 
 - After releasing is done, update the [CHANGELOG.md](https://github.com/open-telemetry/opentelemetry-js/blob/main/CHANGELOG.md) and start new Unreleased label.
 - Create a new commit with the exact title: `Post Release: update CHANGELOG.md`.
 - Go through PR review and merge it to GitHub main branch.
 
-## Known Issues
+### Known Issues
 
 - The `examples/` and `getting-started/` folders are not part of lerna packages, we need to manually bump the version in `package.json`.