Release 1.0.0-beta.0

CHANGELOG.md

@@ -1 +1,40 @@
+## v1.0.0-beta.0 (2021-04-27)
+
+#### :rocket: Enhancement
+* `jest-sarif`
+  * [#13](https://github.com/microsoft/sarif-js-sdk/pull/13) feat: Expanding API surface area by adding single matcher: toBeValidSarifFor(definition) ([@scalvert](https://github.com/scalvert))
+* `jest-sarif`, `sarif-builder`
+  * [#9](https://github.com/microsoft/sarif-js-sdk/pull/9) Adds a new package: @microsoft/jest-sarif ([@scalvert](https://github.com/scalvert))
+
+#### :bug: Bug Fix
+* `jest-sarif`
+  * [#16](https://github.com/microsoft/sarif-js-sdk/pull/16) Updates jsdoc with correct method name ([@scalvert](https://github.com/scalvert))
+  * [#15](https://github.com/microsoft/sarif-js-sdk/pull/15) Updates jest-sarif build to include SARIF schema file in output ([@scalvert](https://github.com/scalvert))
+  * [#11](https://github.com/microsoft/sarif-js-sdk/pull/11) Fixes public exports to ensure types are correctly accessible ([@scalvert](https://github.com/scalvert))
+
+#### :memo: Documentation
+* `jest-sarif`
+  * [#16](https://github.com/microsoft/sarif-js-sdk/pull/16) Updates jsdoc with correct method name ([@scalvert](https://github.com/scalvert))
+
+#### :house: Internal
+* `jest-sarif`, `sarif-builder`
+  * [#18](https://github.com/microsoft/sarif-js-sdk/pull/18) Adding publishConfig.access to package.json of sub-packages ([@scalvert](https://github.com/scalvert))
+  * [#10](https://github.com/microsoft/sarif-js-sdk/pull/10) Updates package.json to use npm over yarn ([@scalvert](https://github.com/scalvert))
+* Other
+  * [#17](https://github.com/microsoft/sarif-js-sdk/pull/17) Updated release-it-yarn-workspaces ([@scalvert](https://github.com/scalvert))
+  * [#2](https://github.com/microsoft/sarif-js-sdk/pull/2) Adding release-it configuration with workspaces publishing support ([@scalvert](https://github.com/scalvert))
+  * [#8](https://github.com/microsoft/sarif-js-sdk/pull/8) Regenerates the lockfile to include specific package name ([@scalvert](https://github.com/scalvert))
+  * [#4](https://github.com/microsoft/sarif-js-sdk/pull/4) Setup basic GitHub Actions CI ([@rwjblue](https://github.com/rwjblue))
+  * [#1](https://github.com/microsoft/sarif-js-sdk/pull/1) Repository infrastructure setup ([@scalvert](https://github.com/scalvert))
+* `jest-sarif`
+  * [#12](https://github.com/microsoft/sarif-js-sdk/pull/12) Adds badges to @microsoft/jest-sarif README ([@scalvert](https://github.com/scalvert))
+* `sarif-builder`
+  * [#6](https://github.com/microsoft/sarif-js-sdk/pull/6) Update .gitignore to ensure inclusion of package files ([@scalvert](https://github.com/scalvert))
+
+#### Committers: 3
+- Eddy Nakamura ([@eddynaka](https://github.com/eddynaka))
+- Robert Jackson ([@rwjblue](https://github.com/rwjblue))
+- Steve Calvert ([@scalvert](https://github.com/scalvert))
+
+
 # Changelog

RELEASE.md

@@ -30,9 +30,9 @@ Once the prep work is completed, the actual release is straight forward:
 
 - First, ensure that you have installed your projects dependencies:
 
-```sh
-npm install
-```
+  ```sh
+  npm install
+  ```
 
 - Second, ensure that you have obtained a
   [GitHub personal access token][generate-token] with the `repo` scope (no
@@ -49,9 +49,27 @@ npm install
 
 - And last (but not least 😁) do your release.
 
-```sh
-npx release-it
-```
+  ```sh
+  npx release-it --no-git.push
+  ```
+
+  :warning: Since this repository has specific protections enabled for the `main` branch, there's an additional step
+  that deviates from the standard `release-it` setup.
+
+  We can't push directly to the `main` branch, so it's necessary to push to a separate `release` branch after the above
+  command completes.
+
+- To release with the required commits, do these additional steps.
+
+  ```sh
+  # create a release branch
+  git checkout -b release
+
+  # push the outstanding release commits to it
+  git push origin release
+  ```
+
+  Then open a PR, get approvals, and merge with `main` to complete the release.
 
 [release-it](https://github.com/release-it/release-it/) manages the actual
 release process. It will prompt you to to choose the version number after which

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sarif-js-sdk",
-  "version": "0.0.1",
+  "version": "1.0.0-beta.0",
   "private": true,
   "description": "JavaScript code and supporting files for working with the 'Static Analysis Results Interchange Format' (SARIF, see oasis-tcs/sarif-spec)",
   "repository": "https://github.com/microsoft/sarif-js-sdk.git",

packages/jest-sarif/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/jest-sarif",
-  "version": "0.0.1",
+  "version": "1.0.0-beta.0",
   "description": "A collection of jest matchers for working with SARIF",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

packages/sarif-builder/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/sarif-builder",
-  "version": "0.0.1",
+  "version": "1.0.0-beta.0",
   "description": "A SARIF log builder for JavaScript",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",