From 98acb57b487b85dfdb93a5be6c00979a78b389d5 Mon Sep 17 00:00:00 2001 From: Ken Chau Date: Wed, 13 Nov 2024 08:03:14 +0000 Subject: [PATCH] Updates --- 404.html | 6 +++--- assets/js/{23.470742a5.js => 23.0dbd4237.js} | 2 +- assets/js/{24.063db0e3.js => 24.e17b0ff9.js} | 2 +- assets/js/{26.6690e44a.js => 26.ba3e8509.js} | 2 +- assets/js/{27.58c59ff7.js => 27.68656ef8.js} | 2 +- assets/js/{32.88025b47.js => 32.0bcf41e9.js} | 2 +- assets/js/{33.99f94a7c.js => 33.80a7b7e8.js} | 2 +- assets/js/{app.805017fe.js => app.c72d448a.js} | 4 ++-- cli/bump.html | 4 ++-- cli/change.html | 4 ++-- cli/check.html | 4 ++-- cli/options.html | 4 ++-- cli/publish.html | 4 ++-- cli/sync.html | 4 ++-- concepts/bump-algorithm.html | 4 ++-- concepts/change-files.html | 4 ++-- concepts/ci-integration.html | 4 ++-- concepts/groups.html | 4 ++-- index.html | 4 ++-- overview/configuration.html | 4 ++-- overview/getting-started.html | 4 ++-- overview/installation.html | 4 ++-- 22 files changed, 39 insertions(+), 39 deletions(-) rename assets/js/{23.470742a5.js => 23.0dbd4237.js} (95%) rename assets/js/{24.063db0e3.js => 24.e17b0ff9.js} (99%) rename assets/js/{26.6690e44a.js => 26.ba3e8509.js} (98%) rename assets/js/{27.58c59ff7.js => 27.68656ef8.js} (98%) rename assets/js/{32.88025b47.js => 32.0bcf41e9.js} (98%) rename assets/js/{33.99f94a7c.js => 33.80a7b7e8.js} (99%) rename assets/js/{app.805017fe.js => app.c72d448a.js} (97%) diff --git a/404.html b/404.html index 37b84746..8bacda8c 100644 --- a/404.html +++ b/404.html @@ -8,13 +8,13 @@ - + -

404

There's nothing here.
+ - + diff --git a/assets/js/23.470742a5.js b/assets/js/23.0dbd4237.js similarity index 95% rename from assets/js/23.470742a5.js rename to assets/js/23.0dbd4237.js index 451254d7..f9f2f5b1 100644 --- a/assets/js/23.470742a5.js +++ b/assets/js/23.0dbd4237.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{348:function(e,t,s){"use strict";s.r(t);var a=s(17),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"bump"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bump"}},[e._v("#")]),e._v(" "),t("code",[e._v("bump")])]),e._v(" "),t("p",[e._v("Bumps versions locally without publishing to the remote git repo or npm registry. This command will also generate changelogs.")]),e._v(" "),t("p",[e._v("This is the same logic that is used by the "),t("code",[e._v("publish")]),e._v(" command, so it's a good practice to bump things locally to see what kind of changes will be made before those changes are published to the npm registry and the remote git repo.")]),e._v(" "),t("p",[e._v("Since this affects files locally only, it's up to you to synchronize the package versions in the remote git repo as well as the npm registry after running this command. (Or if you were using it for testing, simply revert the local changes and run "),t("code",[e._v("beachball publish")]),e._v(".)")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ beachball bump\n")])])]),t("h3",{attrs:{id:"options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),t("p",[e._v("See the "),t("a",{attrs:{href:"./options"}},[e._v("options page")]),e._v(".")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{347:function(e,t,s){"use strict";s.r(t);var a=s(17),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"bump"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bump"}},[e._v("#")]),e._v(" "),t("code",[e._v("bump")])]),e._v(" "),t("p",[e._v("Bumps versions locally without publishing to the remote git repo or npm registry. This command will also generate changelogs.")]),e._v(" "),t("p",[e._v("This is the same logic that is used by the "),t("code",[e._v("publish")]),e._v(" command, so it's a good practice to bump things locally to see what kind of changes will be made before those changes are published to the npm registry and the remote git repo.")]),e._v(" "),t("p",[e._v("Since this affects files locally only, it's up to you to synchronize the package versions in the remote git repo as well as the npm registry after running this command. (Or if you were using it for testing, simply revert the local changes and run "),t("code",[e._v("beachball publish")]),e._v(".)")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ beachball bump\n")])])]),t("h3",{attrs:{id:"options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),t("p",[e._v("See the "),t("a",{attrs:{href:"./options"}},[e._v("options page")]),e._v(".")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/24.063db0e3.js b/assets/js/24.e17b0ff9.js similarity index 99% rename from assets/js/24.063db0e3.js rename to assets/js/24.e17b0ff9.js index c68e6457..80d910e1 100644 --- a/assets/js/24.063db0e3.js +++ b/assets/js/24.e17b0ff9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{347:function(e,a,t){"use strict";t.r(a);var s=t(17),n=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"change"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#change"}},[e._v("#")]),e._v(" "),a("code",[e._v("change")])]),e._v(" "),a("p",[e._v("This command walks you through a couple of questions and will generate the appropriate "),a("a",{attrs:{href:"../concepts/change-files"}},[e._v("change file")]),e._v(" in the "),a("code",[e._v("/change")]),e._v(" directory. The generated file will be committed automatically.")]),e._v(" "),a("p",[e._v("One of the niceties of using this utility to generate change files is that it will "),a("a",{attrs:{href:"./check"}},[e._v("check")]),e._v(" whether or not you even need a change file. Also, it will load recent commit messages to ease change file generation.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("$ beachball change\n")])])]),a("h3",{attrs:{id:"options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),a("p",[e._v("Some "),a("a",{attrs:{href:"./options"}},[e._v("general options")]),e._v(" including "),a("code",[e._v("--branch")]),e._v(" and "),a("code",[e._v("--scope")]),e._v(" also apply for this command.")]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Option")]),e._v(" "),a("th",[e._v("Alias")]),e._v(" "),a("th",[e._v("Default")]),e._v(" "),a("th",[e._v("Description")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[a("code",[e._v("--all")])]),e._v(" "),a("td"),e._v(" "),a("td",[e._v("false")]),e._v(" "),a("td",[e._v("Generate change files for all packages")])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("--message")])]),e._v(" "),a("td",[a("code",[e._v("-m")])]),e._v(" "),a("td",[e._v("(interactive prompt)")]),e._v(" "),a("td",[e._v("Description for all change files")])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("--no-commit")])]),e._v(" "),a("td"),e._v(" "),a("td",[e._v("false")]),e._v(" "),a("td",[e._v("Stage the change files rather than committing")])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("--package")])]),e._v(" "),a("td"),e._v(" "),a("td",[e._v("(changed packages)")]),e._v(" "),a("td",[e._v("Generate change files for these packages (option can be specified multiple times)")])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("--type")])]),e._v(" "),a("td"),e._v(" "),a("td",[e._v("(interactive prompt)")]),e._v(" "),a("td",[e._v("Type for all the change files (must be valid for each package)")])])])]),e._v(" "),a("h3",{attrs:{id:"examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[e._v("#")]),e._v(" Examples")]),e._v(" "),a("p",[e._v("Basic interactive prompt (see "),a("a",{attrs:{href:"#prompt-walkthrough"}},[e._v("walkthrough")]),e._v(" for details):")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("beachball change\n")])])]),a("p",[e._v("Skip the interactive prompt by specifying a message and type for all changed packages:")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("beachball change --type patch --message 'some message'\n")])])]),a("p",[e._v("Generate change file for specific package(s), regardless of changes, and even if a change file already exists for the package in this branch. Each package must be specified with a separate "),a("code",[e._v("--package")]),e._v(" option. (You can also use the "),a("code",[e._v("--message")]),e._v(" and "),a("code",[e._v("--type")]),e._v(" options here.)")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("beachball change --package foo --package bar\n")])])]),a("p",[e._v("Generate change files for all packages, regardless of changes. This would most often be used for build config updates which only touch a shared config file, but actually impact the output of all packages.")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("beachball change --all --type patch --message 'update build output settings'\n")])])]),a("h3",{attrs:{id:"prompt-walkthrough"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prompt-walkthrough"}},[e._v("#")]),e._v(" Prompt walkthrough")]),e._v(" "),a("p",[e._v("If you have changes that are not committed yet (i.e. "),a("code",[e._v("git status")]),e._v(" reports changes), then "),a("code",[e._v("beachball change")]),e._v(" will warn you about these:")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v('$ beachball change\nDefaults to "origin/master"\nThere are uncommitted changes in your repository. Please commit these files first:\n- a-new-file\n')])])]),a("p",[e._v("Make sure to commit "),a("em",[e._v("all")]),e._v(" changes before proceeding with the "),a("code",[e._v("change")]),e._v(" command.")]),e._v(" "),a("p",[e._v("After committing, run "),a("code",[e._v("beachball change")]),e._v(":")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v('$ beachball change\n\nValidating options and change files...\nChecking for changes against "origin/main"\nFound changes in the following packages:\n some-pkg\n')])])]),a("p",[e._v("For each package, the prompt will start by asking for a change "),a("strong",[e._v("type")]),e._v(". This should be chosen based on "),a("a",{attrs:{href:"https://semver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("semantic versioning rules"),a("OutboundLink")],1),e._v(" because it determines how to update the package version. If the change doesn't affect the published package at all (e.g. you just updated some comments), choose "),a("code",[e._v("none")]),e._v(".")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("Please describe the changes for: some-pkg\n? Change type › - Use arrow-keys. Return to submit.\n❯ Patch - bug fixes; no backwards incompatible changes.\n Minor - small feature; backwards compatible changes.\n None - this change does not affect the published package in any way.\n Major - major feature; breaking changes.\n")])])]),a("p",[e._v("Next, it asks for a "),a("strong",[e._v("description")]),e._v(" of the change. You can type any text or choose from a list of recent commit messages.")]),e._v(" "),a("blockquote",[a("p",[e._v("Tip: These descriptions will be collated into a changelog when the change is published by "),a("code",[e._v("beachball publish")]),e._v(", so think about how to describe your change in a way that's helpful and relevant for consumers of the package.")])]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("Please describe the changes for: some-pkg\n? Describe changes (type or choose one) ›\nadding a new file\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{348:function(e,a,t){"use strict";t.r(a);var s=t(17),n=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"change"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#change"}},[e._v("#")]),e._v(" "),a("code",[e._v("change")])]),e._v(" "),a("p",[e._v("This command walks you through a couple of questions and will generate the appropriate "),a("a",{attrs:{href:"../concepts/change-files"}},[e._v("change file")]),e._v(" in the "),a("code",[e._v("/change")]),e._v(" directory. The generated file will be committed automatically.")]),e._v(" "),a("p",[e._v("One of the niceties of using this utility to generate change files is that it will "),a("a",{attrs:{href:"./check"}},[e._v("check")]),e._v(" whether or not you even need a change file. Also, it will load recent commit messages to ease change file generation.")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("$ beachball change\n")])])]),a("h3",{attrs:{id:"options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),a("p",[e._v("Some "),a("a",{attrs:{href:"./options"}},[e._v("general options")]),e._v(" including "),a("code",[e._v("--branch")]),e._v(" and "),a("code",[e._v("--scope")]),e._v(" also apply for this command.")]),e._v(" "),a("table",[a("thead",[a("tr",[a("th",[e._v("Option")]),e._v(" "),a("th",[e._v("Alias")]),e._v(" "),a("th",[e._v("Default")]),e._v(" "),a("th",[e._v("Description")])])]),e._v(" "),a("tbody",[a("tr",[a("td",[a("code",[e._v("--all")])]),e._v(" "),a("td"),e._v(" "),a("td",[e._v("false")]),e._v(" "),a("td",[e._v("Generate change files for all packages")])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("--message")])]),e._v(" "),a("td",[a("code",[e._v("-m")])]),e._v(" "),a("td",[e._v("(interactive prompt)")]),e._v(" "),a("td",[e._v("Description for all change files")])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("--no-commit")])]),e._v(" "),a("td"),e._v(" "),a("td",[e._v("false")]),e._v(" "),a("td",[e._v("Stage the change files rather than committing")])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("--package")])]),e._v(" "),a("td"),e._v(" "),a("td",[e._v("(changed packages)")]),e._v(" "),a("td",[e._v("Generate change files for these packages (option can be specified multiple times)")])]),e._v(" "),a("tr",[a("td",[a("code",[e._v("--type")])]),e._v(" "),a("td"),e._v(" "),a("td",[e._v("(interactive prompt)")]),e._v(" "),a("td",[e._v("Type for all the change files (must be valid for each package)")])])])]),e._v(" "),a("h3",{attrs:{id:"examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[e._v("#")]),e._v(" Examples")]),e._v(" "),a("p",[e._v("Basic interactive prompt (see "),a("a",{attrs:{href:"#prompt-walkthrough"}},[e._v("walkthrough")]),e._v(" for details):")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("beachball change\n")])])]),a("p",[e._v("Skip the interactive prompt by specifying a message and type for all changed packages:")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("beachball change --type patch --message 'some message'\n")])])]),a("p",[e._v("Generate change file for specific package(s), regardless of changes, and even if a change file already exists for the package in this branch. Each package must be specified with a separate "),a("code",[e._v("--package")]),e._v(" option. (You can also use the "),a("code",[e._v("--message")]),e._v(" and "),a("code",[e._v("--type")]),e._v(" options here.)")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("beachball change --package foo --package bar\n")])])]),a("p",[e._v("Generate change files for all packages, regardless of changes. This would most often be used for build config updates which only touch a shared config file, but actually impact the output of all packages.")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("beachball change --all --type patch --message 'update build output settings'\n")])])]),a("h3",{attrs:{id:"prompt-walkthrough"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#prompt-walkthrough"}},[e._v("#")]),e._v(" Prompt walkthrough")]),e._v(" "),a("p",[e._v("If you have changes that are not committed yet (i.e. "),a("code",[e._v("git status")]),e._v(" reports changes), then "),a("code",[e._v("beachball change")]),e._v(" will warn you about these:")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v('$ beachball change\nDefaults to "origin/master"\nThere are uncommitted changes in your repository. Please commit these files first:\n- a-new-file\n')])])]),a("p",[e._v("Make sure to commit "),a("em",[e._v("all")]),e._v(" changes before proceeding with the "),a("code",[e._v("change")]),e._v(" command.")]),e._v(" "),a("p",[e._v("After committing, run "),a("code",[e._v("beachball change")]),e._v(":")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v('$ beachball change\n\nValidating options and change files...\nChecking for changes against "origin/main"\nFound changes in the following packages:\n some-pkg\n')])])]),a("p",[e._v("For each package, the prompt will start by asking for a change "),a("strong",[e._v("type")]),e._v(". This should be chosen based on "),a("a",{attrs:{href:"https://semver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("semantic versioning rules"),a("OutboundLink")],1),e._v(" because it determines how to update the package version. If the change doesn't affect the published package at all (e.g. you just updated some comments), choose "),a("code",[e._v("none")]),e._v(".")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("Please describe the changes for: some-pkg\n? Change type › - Use arrow-keys. Return to submit.\n❯ Patch - bug fixes; no backwards incompatible changes.\n Minor - small feature; backwards compatible changes.\n None - this change does not affect the published package in any way.\n Major - major feature; breaking changes.\n")])])]),a("p",[e._v("Next, it asks for a "),a("strong",[e._v("description")]),e._v(" of the change. You can type any text or choose from a list of recent commit messages.")]),e._v(" "),a("blockquote",[a("p",[e._v("Tip: These descriptions will be collated into a changelog when the change is published by "),a("code",[e._v("beachball publish")]),e._v(", so think about how to describe your change in a way that's helpful and relevant for consumers of the package.")])]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("Please describe the changes for: some-pkg\n? Describe changes (type or choose one) ›\nadding a new file\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/26.6690e44a.js b/assets/js/26.ba3e8509.js similarity index 98% rename from assets/js/26.6690e44a.js rename to assets/js/26.ba3e8509.js index 7ed9ea62..d38e3194 100644 --- a/assets/js/26.6690e44a.js +++ b/assets/js/26.ba3e8509.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{350:function(t,e,v){"use strict";v.r(e);var _=v(17),o=Object(_.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"beachball-cli-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beachball-cli-options"}},[t._v("#")]),t._v(" Beachball CLI Options")]),t._v(" "),e("p",[t._v("For the latest full list of supported options, see "),e("code",[t._v("CliOptions")]),t._v(" "),e("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[t._v("in this file"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"general-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general-options"}},[t._v("#")]),t._v(" General options")]),t._v(" "),e("p",[t._v("These apply to most CLI commands.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Option")]),t._v(" "),e("th",[t._v("Alias")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("--branch")])]),t._v(" "),e("td",[e("code",[t._v("-b")])]),t._v(" "),e("td",[t._v("Detected default branch in default remote, falling back to "),e("code",[t._v("'origin/master'")])]),t._v(" "),e("td",[t._v("target branch from origin")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--no-fetch")])]),t._v(" "),e("td"),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Disable fetching")])])])]),t._v(" "),e("h2",{attrs:{id:"change-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#change-options"}},[t._v("#")]),t._v(" "),e("code",[t._v("change")]),t._v(" options")]),t._v(" "),e("p",[t._v("See the "),e("a",{attrs:{href:"./change"}},[e("code",[t._v("change")]),t._v(" page")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"bumping-and-publishing-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bumping-and-publishing-options"}},[t._v("#")]),t._v(" Bumping and publishing options")]),t._v(" "),e("p",[t._v("These options are applicable for the "),e("code",[t._v("publish")]),t._v(" command, as well as "),e("code",[t._v("bump")]),t._v(" and/or "),e("code",[t._v("canary")]),t._v(" in some cases.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Option")]),t._v(" "),e("th",[t._v("Alias")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("--authType")])]),t._v(" "),e("td",[e("code",[t._v("-a")])]),t._v(" "),e("td",[e("code",[t._v("'authtoken'")])]),t._v(" "),e("td",[t._v("type of token argument, affecting how it is applied to npm commands.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--message")])]),t._v(" "),e("td",[e("code",[t._v("-m")])]),t._v(" "),e("td",[e("code",[t._v("'applying package updates'")])]),t._v(" "),e("td",[t._v("custom message for the checkin")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--git-tags")]),t._v(", "),e("code",[t._v("--no-git-tags")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" ("),e("code",[t._v("--git-tags")]),t._v(")")]),t._v(" "),e("td",[t._v("whether to create git tags for published packages")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--publish")]),t._v(", "),e("code",[t._v("--no-publish")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" ("),e("code",[t._v("--publish")]),t._v(")")]),t._v(" "),e("td",[t._v("whether to publish to the npm registry")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--push")]),t._v(", "),e("code",[t._v("--no-push")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" ("),e("code",[t._v("--push")]),t._v(")")]),t._v(" "),e("td",[t._v("whether to push changes back to git remote origin")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--prerelease-prefix")])]),t._v(" "),e("td"),t._v(" "),e("td"),t._v(" "),e("td",[t._v("prerelease prefix for packages that are specified to receive a prerelease bump ("),e("code",[t._v("--prerelease-prefix beta")]),t._v(" makes the "),e("code",[t._v("x.y.z-beta")]),t._v(" version)")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--registry")])]),t._v(" "),e("td",[e("code",[t._v("-r")])]),t._v(" "),e("td",[e("code",[t._v("'https://registry.npmjs.org'")])]),t._v(" "),e("td",[t._v("npm registry for publishing")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--retries")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("number of retries for a package publish before failing")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--tag")])]),t._v(" "),e("td",[e("code",[t._v("-t")])]),t._v(" "),e("td",[e("code",[t._v("'latest'")])]),t._v(" "),e("td",[t._v("dist-tag for npm publishes")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--token")])]),t._v(" "),e("td",[e("code",[t._v("-n")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("credential to use with npm commands. its type is specified with the "),e("code",[t._v("--authType")]),t._v(" argument")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--verbose")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("prints additional information to the console")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--yes")])]),t._v(" "),e("td",[e("code",[t._v("-y")])]),t._v(" "),e("td",[t._v("if CI detected, "),e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("skips the prompts for publish")])])])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{351:function(t,e,v){"use strict";v.r(e);var _=v(17),o=Object(_.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"beachball-cli-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beachball-cli-options"}},[t._v("#")]),t._v(" Beachball CLI Options")]),t._v(" "),e("p",[t._v("For the latest full list of supported options, see "),e("code",[t._v("CliOptions")]),t._v(" "),e("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[t._v("in this file"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"general-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general-options"}},[t._v("#")]),t._v(" General options")]),t._v(" "),e("p",[t._v("These apply to most CLI commands.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Option")]),t._v(" "),e("th",[t._v("Alias")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("--branch")])]),t._v(" "),e("td",[e("code",[t._v("-b")])]),t._v(" "),e("td",[t._v("Detected default branch in default remote, falling back to "),e("code",[t._v("'origin/master'")])]),t._v(" "),e("td",[t._v("target branch from origin")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--no-fetch")])]),t._v(" "),e("td"),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Disable fetching")])])])]),t._v(" "),e("h2",{attrs:{id:"change-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#change-options"}},[t._v("#")]),t._v(" "),e("code",[t._v("change")]),t._v(" options")]),t._v(" "),e("p",[t._v("See the "),e("a",{attrs:{href:"./change"}},[e("code",[t._v("change")]),t._v(" page")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"bumping-and-publishing-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bumping-and-publishing-options"}},[t._v("#")]),t._v(" Bumping and publishing options")]),t._v(" "),e("p",[t._v("These options are applicable for the "),e("code",[t._v("publish")]),t._v(" command, as well as "),e("code",[t._v("bump")]),t._v(" and/or "),e("code",[t._v("canary")]),t._v(" in some cases.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Option")]),t._v(" "),e("th",[t._v("Alias")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("--authType")])]),t._v(" "),e("td",[e("code",[t._v("-a")])]),t._v(" "),e("td",[e("code",[t._v("'authtoken'")])]),t._v(" "),e("td",[t._v("type of token argument, affecting how it is applied to npm commands.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--message")])]),t._v(" "),e("td",[e("code",[t._v("-m")])]),t._v(" "),e("td",[e("code",[t._v("'applying package updates'")])]),t._v(" "),e("td",[t._v("custom message for the checkin")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--git-tags")]),t._v(", "),e("code",[t._v("--no-git-tags")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" ("),e("code",[t._v("--git-tags")]),t._v(")")]),t._v(" "),e("td",[t._v("whether to create git tags for published packages")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--publish")]),t._v(", "),e("code",[t._v("--no-publish")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" ("),e("code",[t._v("--publish")]),t._v(")")]),t._v(" "),e("td",[t._v("whether to publish to the npm registry")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--push")]),t._v(", "),e("code",[t._v("--no-push")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" ("),e("code",[t._v("--push")]),t._v(")")]),t._v(" "),e("td",[t._v("whether to push changes back to git remote origin")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--prerelease-prefix")])]),t._v(" "),e("td"),t._v(" "),e("td"),t._v(" "),e("td",[t._v("prerelease prefix for packages that are specified to receive a prerelease bump ("),e("code",[t._v("--prerelease-prefix beta")]),t._v(" makes the "),e("code",[t._v("x.y.z-beta")]),t._v(" version)")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--registry")])]),t._v(" "),e("td",[e("code",[t._v("-r")])]),t._v(" "),e("td",[e("code",[t._v("'https://registry.npmjs.org'")])]),t._v(" "),e("td",[t._v("npm registry for publishing")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--retries")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("number of retries for a package publish before failing")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--tag")])]),t._v(" "),e("td",[e("code",[t._v("-t")])]),t._v(" "),e("td",[e("code",[t._v("'latest'")])]),t._v(" "),e("td",[t._v("dist-tag for npm publishes")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--token")])]),t._v(" "),e("td",[e("code",[t._v("-n")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("credential to use with npm commands. its type is specified with the "),e("code",[t._v("--authType")]),t._v(" argument")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--verbose")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("prints additional information to the console")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("--yes")])]),t._v(" "),e("td",[e("code",[t._v("-y")])]),t._v(" "),e("td",[t._v("if CI detected, "),e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("skips the prompts for publish")])])])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/27.58c59ff7.js b/assets/js/27.68656ef8.js similarity index 98% rename from assets/js/27.58c59ff7.js rename to assets/js/27.68656ef8.js index d3df20e3..f0ee69da 100644 --- a/assets/js/27.58c59ff7.js +++ b/assets/js/27.68656ef8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{351:function(e,t,s){"use strict";s.r(t);var a=s(17),i=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"publish"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#publish"}},[e._v("#")]),e._v(" "),t("code",[e._v("publish")])]),e._v(" "),t("p",[e._v("Publishing automates all the bumping and synchronizing of package versions in the git remote as well as the npm registry.")]),e._v(" "),t("h3",{attrs:{id:"options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),t("p",[e._v("See the "),t("a",{attrs:{href:"./options"}},[e._v("options page")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"algorithm"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#algorithm"}},[e._v("#")]),e._v(" Algorithm")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("publish")]),e._v(" command is designed to run steps in an order that minimizes the chances of mid-publish failure by doing validation upfront.")]),e._v(" "),t("p",[t("code",[e._v("beachball publish")]),e._v(" performs the following steps:")]),e._v(" "),t("ol",[t("li",[e._v("Validate that options and change files are valid")]),e._v(" "),t("li",[e._v("Bump and publish to npm (unless disabled):\n"),t("ol",[t("li",[e._v("Bump the package versions locally")]),e._v(" "),t("li",[e._v("Generate the changelog files (unless disabled)")]),e._v(" "),t("li",[e._v("Delete change files locally (unless disabled)")]),e._v(" "),t("li",[e._v("Validate that nothing to be published depends on a private package")]),e._v(" "),t("li",[e._v("Publish packages to npm in topological order based on the dependency graph (to reduce the chances that if there's a failure partway through, a published package might require unpublished versions)")])])]),e._v(" "),t("li",[e._v("Bump and push to git (unless bumping or pushing is disabled):\n"),t("ol",[t("li",[e._v("Revert any previous changes (from the publish step)")]),e._v(" "),t("li",[e._v("Merge the latest changes from the remote branch to avoid merge conflicts (unless fetching is disabled)")]),e._v(" "),t("li",[e._v("Bump the versions locally")]),e._v(" "),t("li",[e._v("Generate the changelog files (unless disabled)")]),e._v(" "),t("li",[e._v("Delete change files locally (unless disabled)")]),e._v(" "),t("li",[e._v("Commit the changes")]),e._v(" "),t("li",[e._v("Create git tags for new package versions (unless disabled)")]),e._v(" "),t("li",[e._v("Push the changes and tags")])])])]),e._v(" "),t("p",[e._v("It might be surprising that "),t("code",[e._v("beachball publish")]),e._v(" does so many steps, especially the step about reverting changes! In most version bumping systems that automate syncing the git repo and npm registry, they assume that the source code is still fresh once it's time to push changes back to the git repository. This is rarely the case for large repos with many developers. So, "),t("code",[e._v("beachball")]),e._v(" fetches the latest changes before pushing back to the target branch to avoid merge conflicts.")]),e._v(" "),t("h3",{attrs:{id:"example-ci-workflow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-ci-workflow"}},[e._v("#")]),e._v(" Example CI workflow")]),e._v(" "),t("p",[e._v("See the "),t("a",{attrs:{href:"../concepts/ci-integration"}},[e._v("CI integration page")]),e._v(" details and examples for how to run "),t("code",[e._v("beachball publish")]),e._v(" in CI.")]),e._v(" "),t("h3",{attrs:{id:"recovering-from-failed-publish"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recovering-from-failed-publish"}},[e._v("#")]),e._v(" Recovering from failed publish")]),e._v(" "),t("p",[e._v("If the "),t("code",[e._v("publish")]),e._v(" command fails partway through, after some versions have been published to the registry, you'll need to run "),t("a",{attrs:{href:"./sync"}},[t("code",[e._v("beachball sync")])]),e._v(" and commit the changes.")])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{350:function(e,t,s){"use strict";s.r(t);var a=s(17),i=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"publish"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#publish"}},[e._v("#")]),e._v(" "),t("code",[e._v("publish")])]),e._v(" "),t("p",[e._v("Publishing automates all the bumping and synchronizing of package versions in the git remote as well as the npm registry.")]),e._v(" "),t("h3",{attrs:{id:"options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),t("p",[e._v("See the "),t("a",{attrs:{href:"./options"}},[e._v("options page")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"algorithm"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#algorithm"}},[e._v("#")]),e._v(" Algorithm")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("publish")]),e._v(" command is designed to run steps in an order that minimizes the chances of mid-publish failure by doing validation upfront.")]),e._v(" "),t("p",[t("code",[e._v("beachball publish")]),e._v(" performs the following steps:")]),e._v(" "),t("ol",[t("li",[e._v("Validate that options and change files are valid")]),e._v(" "),t("li",[e._v("Bump and publish to npm (unless disabled):\n"),t("ol",[t("li",[e._v("Bump the package versions locally")]),e._v(" "),t("li",[e._v("Generate the changelog files (unless disabled)")]),e._v(" "),t("li",[e._v("Delete change files locally (unless disabled)")]),e._v(" "),t("li",[e._v("Validate that nothing to be published depends on a private package")]),e._v(" "),t("li",[e._v("Publish packages to npm in topological order based on the dependency graph (to reduce the chances that if there's a failure partway through, a published package might require unpublished versions)")])])]),e._v(" "),t("li",[e._v("Bump and push to git (unless bumping or pushing is disabled):\n"),t("ol",[t("li",[e._v("Revert any previous changes (from the publish step)")]),e._v(" "),t("li",[e._v("Merge the latest changes from the remote branch to avoid merge conflicts (unless fetching is disabled)")]),e._v(" "),t("li",[e._v("Bump the versions locally")]),e._v(" "),t("li",[e._v("Generate the changelog files (unless disabled)")]),e._v(" "),t("li",[e._v("Delete change files locally (unless disabled)")]),e._v(" "),t("li",[e._v("Commit the changes")]),e._v(" "),t("li",[e._v("Create git tags for new package versions (unless disabled)")]),e._v(" "),t("li",[e._v("Push the changes and tags")])])])]),e._v(" "),t("p",[e._v("It might be surprising that "),t("code",[e._v("beachball publish")]),e._v(" does so many steps, especially the step about reverting changes! In most version bumping systems that automate syncing the git repo and npm registry, they assume that the source code is still fresh once it's time to push changes back to the git repository. This is rarely the case for large repos with many developers. So, "),t("code",[e._v("beachball")]),e._v(" fetches the latest changes before pushing back to the target branch to avoid merge conflicts.")]),e._v(" "),t("h3",{attrs:{id:"example-ci-workflow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#example-ci-workflow"}},[e._v("#")]),e._v(" Example CI workflow")]),e._v(" "),t("p",[e._v("See the "),t("a",{attrs:{href:"../concepts/ci-integration"}},[e._v("CI integration page")]),e._v(" details and examples for how to run "),t("code",[e._v("beachball publish")]),e._v(" in CI.")]),e._v(" "),t("h3",{attrs:{id:"recovering-from-failed-publish"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recovering-from-failed-publish"}},[e._v("#")]),e._v(" Recovering from failed publish")]),e._v(" "),t("p",[e._v("If the "),t("code",[e._v("publish")]),e._v(" command fails partway through, after some versions have been published to the registry, you'll need to run "),t("a",{attrs:{href:"./sync"}},[t("code",[e._v("beachball sync")])]),e._v(" and commit the changes.")])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/32.88025b47.js b/assets/js/32.0bcf41e9.js similarity index 98% rename from assets/js/32.88025b47.js rename to assets/js/32.0bcf41e9.js index 59e68e00..9a392a89 100644 --- a/assets/js/32.88025b47.js +++ b/assets/js/32.0bcf41e9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{355:function(e,s,t){"use strict";t.r(s);var a=t(17),n=Object(a.a)({},(function(){var e=this,s=e._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"version-groups"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#version-groups"}},[e._v("#")]),e._v(" Version Groups")]),e._v(" "),s("p",[e._v("By default, all packages in the repository are versioned based solely on the changes as specified by the change files. Developers are expected to create these change files along with the bump type for the packages as they go.")]),e._v(" "),s("p",[e._v("Some projects require bumping versions together so that the consumers really only need to remember one single version number when bumping related packages. The most famous of this strategy is Babel that versions all their related packages together with the locked step versioning.")]),e._v(" "),s("p",[s("code",[e._v("beachball")]),e._v(" strives to be automated and flexible, so it provides a concept of version groups. Whenever one of the packages of one of the packages inside a group is bumped, the entire group's packages will get bumped the same way.")]),e._v(" "),s("blockquote",[s("p",[e._v("Note: a package cannot belong to multiple groups - beachball will not allow its commands to work with that configuration")])]),e._v(" "),s("h3",{attrs:{id:"configuring-groups"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#configuring-groups"}},[e._v("#")]),e._v(" Configuring groups")]),e._v(" "),s("p",[e._v("In the "),s("a",{attrs:{href:"../overview/configuration"}},[e._v("configuration")]),e._v(" section, we discussed how to configure "),s("code",[e._v("beachball")]),e._v(". Here's an example of a config file named "),s("code",[e._v("beachball.config.js")]),e._v(":")]),e._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[e._v("module"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("exports "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("bumpDeps")]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),s("p",[e._v("We can add a group by adding it to the configuration like this:")]),e._v(" "),s("div",{staticClass:"language-diff extra-class"},[s("pre",{pre:!0,attrs:{class:"language-diff"}},[s("code",[e._v("module.exports = {\n"),s("span",{pre:!0,attrs:{class:"token unchanged"}},[s("span",{pre:!0,attrs:{class:"token prefix unchanged"}},[e._v(" ")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" bumpDeps: true\n")])]),s("span",{pre:!0,attrs:{class:"token inserted-sign inserted"}},[s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" groups: [\n")]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" {\n")]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(' name: "group name",\n')]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(' include: ["packages/groupfoo/*"],\n')]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(' exclude: ["packages/groupfoo/bar"]\n')]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" }\n")]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" ]\n")])]),e._v("}\n")])])]),s("p",[s("code",[e._v("beachball")]),e._v(" uses "),s("code",[e._v("minimatch")]),e._v(" to match which packages belong to which group via this configuration. In the above configuration, packages located inside "),s("code",[e._v("packages/groupfoo")]),e._v(" would be bumped together.")]),e._v(" "),s("blockquote",[s("p",[e._v("NOTE: Beachball does not guarantee currently that these packages have the same version number, but that it will be bumped at the same rate. This is an area of active development, so please consider submitting feature request issues to change its behavior with justifications")])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{356:function(e,s,t){"use strict";t.r(s);var a=t(17),n=Object(a.a)({},(function(){var e=this,s=e._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[s("h1",{attrs:{id:"version-groups"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#version-groups"}},[e._v("#")]),e._v(" Version Groups")]),e._v(" "),s("p",[e._v("By default, all packages in the repository are versioned based solely on the changes as specified by the change files. Developers are expected to create these change files along with the bump type for the packages as they go.")]),e._v(" "),s("p",[e._v("Some projects require bumping versions together so that the consumers really only need to remember one single version number when bumping related packages. The most famous of this strategy is Babel that versions all their related packages together with the locked step versioning.")]),e._v(" "),s("p",[s("code",[e._v("beachball")]),e._v(" strives to be automated and flexible, so it provides a concept of version groups. Whenever one of the packages of one of the packages inside a group is bumped, the entire group's packages will get bumped the same way.")]),e._v(" "),s("blockquote",[s("p",[e._v("Note: a package cannot belong to multiple groups - beachball will not allow its commands to work with that configuration")])]),e._v(" "),s("h3",{attrs:{id:"configuring-groups"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#configuring-groups"}},[e._v("#")]),e._v(" Configuring groups")]),e._v(" "),s("p",[e._v("In the "),s("a",{attrs:{href:"../overview/configuration"}},[e._v("configuration")]),e._v(" section, we discussed how to configure "),s("code",[e._v("beachball")]),e._v(". Here's an example of a config file named "),s("code",[e._v("beachball.config.js")]),e._v(":")]),e._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[e._v("module"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("exports "),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("bumpDeps")]),s("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),s("p",[e._v("We can add a group by adding it to the configuration like this:")]),e._v(" "),s("div",{staticClass:"language-diff extra-class"},[s("pre",{pre:!0,attrs:{class:"language-diff"}},[s("code",[e._v("module.exports = {\n"),s("span",{pre:!0,attrs:{class:"token unchanged"}},[s("span",{pre:!0,attrs:{class:"token prefix unchanged"}},[e._v(" ")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" bumpDeps: true\n")])]),s("span",{pre:!0,attrs:{class:"token inserted-sign inserted"}},[s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" groups: [\n")]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" {\n")]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(' name: "group name",\n')]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(' include: ["packages/groupfoo/*"],\n')]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(' exclude: ["packages/groupfoo/bar"]\n')]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" }\n")]),s("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),s("span",{pre:!0,attrs:{class:"token line"}},[e._v(" ]\n")])]),e._v("}\n")])])]),s("p",[s("code",[e._v("beachball")]),e._v(" uses "),s("code",[e._v("minimatch")]),e._v(" to match which packages belong to which group via this configuration. In the above configuration, packages located inside "),s("code",[e._v("packages/groupfoo")]),e._v(" would be bumped together.")]),e._v(" "),s("blockquote",[s("p",[e._v("NOTE: Beachball does not guarantee currently that these packages have the same version number, but that it will be bumped at the same rate. This is an area of active development, so please consider submitting feature request issues to change its behavior with justifications")])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/33.99f94a7c.js b/assets/js/33.80a7b7e8.js similarity index 99% rename from assets/js/33.99f94a7c.js rename to assets/js/33.80a7b7e8.js index e571d2c9..9ae51cf2 100644 --- a/assets/js/33.99f94a7c.js +++ b/assets/js/33.80a7b7e8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{356:function(e,t,o){"use strict";o.r(t);var a=o(17),v=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration"}},[e._v("#")]),e._v(" Configuration")]),e._v(" "),t("p",[e._v("For most uses you probably do not need any specific configuration on each package within your repository. But there are a few options to customize "),t("code",[e._v("beachball")]),e._v("'s behavior.")]),e._v(" "),t("p",[e._v("There are two types of configurations:")]),e._v(" "),t("ol",[t("li",[e._v("repository config")]),e._v(" "),t("li",[e._v("package config")])]),e._v(" "),t("h2",{attrs:{id:"configuration-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-files"}},[e._v("#")]),e._v(" Configuration files")]),e._v(" "),t("p",[t("code",[e._v("beachball")]),e._v(" uses "),t("a",{attrs:{href:"https://github.com/davidtheclark/cosmiconfig",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("cosmiconfig")]),t("OutboundLink")],1),e._v(" to read its configuration, so you can specify configuration in several ways (in addition to CLI arguments).")]),e._v(" "),t("ul",[t("li",[t("code",[e._v('"beachball"')]),e._v(" key inside "),t("code",[e._v("package.json")])]),e._v(" "),t("li",[t("code",[e._v(".beachballrc")])]),e._v(" "),t("li",[t("code",[e._v(".beachballrc.json")])]),e._v(" "),t("li",[t("code",[e._v("beachball.config.js")])])]),e._v(" "),t("h3",{attrs:{id:"beachball-config-js"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#beachball-config-js"}},[e._v("#")]),e._v(" "),t("code",[e._v("beachball.config.js")])]),e._v(" "),t("p",[e._v("In many cases, you'll want to use a JavaScript config file (written as a CommonJS module), since this is the most flexible and allows comments.")]),e._v(" "),t("div",{staticClass:"language-js extra-class"},[t("pre",{pre:!0,attrs:{class:"language-js"}},[t("code",[e._v("module"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("exports "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("key")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" value"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("key2")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" value2\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("key3")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" value3\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Config files can be placed in either the root of a repo and/or within individual packages (package config overrides the repo config where applicable). For example:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("packages/\n foo/\n src/\n package.json\n beachball.config.js\n bar/\n src/\n package.json\npackage.json\nbeachball.config.js\n")])])]),t("p",[e._v("It's also common to have a repo-level "),t("code",[e._v("beachball.config.js")]),e._v(" and any individual package overrides (if they're simple) in the "),t("code",[e._v('"beachball"')]),e._v(" key in the package's "),t("code",[e._v("package.json")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),t("p",[e._v("For the latest full list of supported options, see "),t("code",[e._v("RepoOptions")]),e._v(" "),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("in this file"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Option")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Option Type")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("access")])]),e._v(" "),t("td",[t("code",[e._v("'public'")]),e._v(" or "),t("code",[e._v("'restricted'")])]),e._v(" "),t("td",[t("code",[e._v("'restricted'")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("publishes private packages access level")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("branch")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td",[t("code",[e._v("'origin/master'")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("the target branch (with remote)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("bumpDeps")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("bump dependent packages during publish (bump A if A depends on B)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("changeFilePrompt")])]),e._v(" "),t("td",[t("code",[e._v("ChangeFilePromptOptions")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/ChangeFilePrompt.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("details"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("customize the prompt for change files (can be used to add custom fields)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("changehint")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("hint message for when change files are not detected but required")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("changeDir")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td",[t("code",[e._v("change")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("directory of the change files")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("changelog")])]),e._v(" "),t("td",[t("code",[e._v("ChangelogOptions")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/ChangelogOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("details"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("changelog rendering and grouping options")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("defaultNpmTag")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td",[t("code",[e._v("'latest'")])]),e._v(" "),t("td",[e._v("package")]),e._v(" "),t("td",[e._v("the default dist-tag used for NPM publish")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("disallowedChangeTypes")])]),e._v(" "),t("td",[e._v("string[]")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo, group, package")]),e._v(" "),t("td",[e._v("what change types are disallowed")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("fetch")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("fetch from remote before doing diff comparisons")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("generateChangelog")])]),e._v(" "),t("td",[e._v("bool, "),t("code",[e._v("'md'")]),e._v(", or "),t("code",[e._v("'json'")])]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("whether to generate "),t("code",[e._v("CHANGELOG.md/json")]),e._v(" ("),t("code",[e._v("'md'")]),e._v(" or "),t("code",[e._v("'json'")]),e._v(" to generate only that type)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("gitTags")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo, package")]),e._v(" "),t("td",[e._v("whether to create git tags for published packages (eg: foo_v1.0.1)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("groups")])]),e._v(" "),t("td",[t("code",[e._v("VersionGroupOptions[]")]),e._v(" ("),t("a",{attrs:{href:"../concepts/groups"}},[e._v("details")]),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("specifies groups of packages that need to be version bumped at the same time")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("groupChanges")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("false")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("will write multiple changes to a single changefile")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("hooks")])]),e._v(" "),t("td",[t("code",[e._v("HooksOptions")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("details"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("hooks for custom pre/post publish actions")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("ignorePatterns")])]),e._v(" "),t("td",[e._v("string[]")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("ignore changes in these files (minimatch patterns; negations not supported)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("package")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("specifies which package the command relates to (overrides change detection based on "),t("code",[e._v("git diff")]),e._v(")")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("prereleasePrefix")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("prerelease prefix for packages that are specified to receive a prerelease bump")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("publish")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("whether to publish to npm registry")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("push")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("whether to push to the remote git branch")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("registry")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("target NPM registry to publish")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("retries")])]),e._v(" "),t("td",[e._v("number")]),e._v(" "),t("td",[t("code",[e._v("3")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("number of retries for a package publish before failing")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("shouldPublish")])]),e._v(" "),t("td",[e._v("false | undefined")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("package")]),e._v(" "),t("td",[e._v("manually disable publishing of a package by beachball (does not work to force publishing)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("tag")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td",[t("code",[e._v("'latest'")])]),e._v(" "),t("td",[e._v("repo, package")]),e._v(" "),t("td",[e._v("dist-tag for npm when published")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("transform")])]),e._v(" "),t("td",[t("code",[e._v("TransformOptions")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("details"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("transformations for change files")])])])])])}),[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{355:function(e,t,o){"use strict";o.r(t);var a=o(17),v=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration"}},[e._v("#")]),e._v(" Configuration")]),e._v(" "),t("p",[e._v("For most uses you probably do not need any specific configuration on each package within your repository. But there are a few options to customize "),t("code",[e._v("beachball")]),e._v("'s behavior.")]),e._v(" "),t("p",[e._v("There are two types of configurations:")]),e._v(" "),t("ol",[t("li",[e._v("repository config")]),e._v(" "),t("li",[e._v("package config")])]),e._v(" "),t("h2",{attrs:{id:"configuration-files"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-files"}},[e._v("#")]),e._v(" Configuration files")]),e._v(" "),t("p",[t("code",[e._v("beachball")]),e._v(" uses "),t("a",{attrs:{href:"https://github.com/davidtheclark/cosmiconfig",target:"_blank",rel:"noopener noreferrer"}},[t("code",[e._v("cosmiconfig")]),t("OutboundLink")],1),e._v(" to read its configuration, so you can specify configuration in several ways (in addition to CLI arguments).")]),e._v(" "),t("ul",[t("li",[t("code",[e._v('"beachball"')]),e._v(" key inside "),t("code",[e._v("package.json")])]),e._v(" "),t("li",[t("code",[e._v(".beachballrc")])]),e._v(" "),t("li",[t("code",[e._v(".beachballrc.json")])]),e._v(" "),t("li",[t("code",[e._v("beachball.config.js")])])]),e._v(" "),t("h3",{attrs:{id:"beachball-config-js"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#beachball-config-js"}},[e._v("#")]),e._v(" "),t("code",[e._v("beachball.config.js")])]),e._v(" "),t("p",[e._v("In many cases, you'll want to use a JavaScript config file (written as a CommonJS module), since this is the most flexible and allows comments.")]),e._v(" "),t("div",{staticClass:"language-js extra-class"},[t("pre",{pre:!0,attrs:{class:"language-js"}},[t("code",[e._v("module"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("exports "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("key")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" value"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("key2")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" value2\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("key3")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" value3\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Config files can be placed in either the root of a repo and/or within individual packages (package config overrides the repo config where applicable). For example:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("packages/\n foo/\n src/\n package.json\n beachball.config.js\n bar/\n src/\n package.json\npackage.json\nbeachball.config.js\n")])])]),t("p",[e._v("It's also common to have a repo-level "),t("code",[e._v("beachball.config.js")]),e._v(" and any individual package overrides (if they're simple) in the "),t("code",[e._v('"beachball"')]),e._v(" key in the package's "),t("code",[e._v("package.json")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),t("p",[e._v("For the latest full list of supported options, see "),t("code",[e._v("RepoOptions")]),e._v(" "),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("in this file"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Option")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Option Type")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("access")])]),e._v(" "),t("td",[t("code",[e._v("'public'")]),e._v(" or "),t("code",[e._v("'restricted'")])]),e._v(" "),t("td",[t("code",[e._v("'restricted'")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("publishes private packages access level")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("branch")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td",[t("code",[e._v("'origin/master'")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("the target branch (with remote)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("bumpDeps")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("bump dependent packages during publish (bump A if A depends on B)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("changeFilePrompt")])]),e._v(" "),t("td",[t("code",[e._v("ChangeFilePromptOptions")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/ChangeFilePrompt.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("details"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("customize the prompt for change files (can be used to add custom fields)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("changehint")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("hint message for when change files are not detected but required")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("changeDir")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td",[t("code",[e._v("change")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("directory of the change files")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("changelog")])]),e._v(" "),t("td",[t("code",[e._v("ChangelogOptions")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/ChangelogOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("details"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("changelog rendering and grouping options")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("defaultNpmTag")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td",[t("code",[e._v("'latest'")])]),e._v(" "),t("td",[e._v("package")]),e._v(" "),t("td",[e._v("the default dist-tag used for NPM publish")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("disallowedChangeTypes")])]),e._v(" "),t("td",[e._v("string[]")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo, group, package")]),e._v(" "),t("td",[e._v("what change types are disallowed")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("fetch")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("fetch from remote before doing diff comparisons")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("generateChangelog")])]),e._v(" "),t("td",[e._v("bool, "),t("code",[e._v("'md'")]),e._v(", or "),t("code",[e._v("'json'")])]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("whether to generate "),t("code",[e._v("CHANGELOG.md/json")]),e._v(" ("),t("code",[e._v("'md'")]),e._v(" or "),t("code",[e._v("'json'")]),e._v(" to generate only that type)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("gitTags")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo, package")]),e._v(" "),t("td",[e._v("whether to create git tags for published packages (eg: foo_v1.0.1)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("groups")])]),e._v(" "),t("td",[t("code",[e._v("VersionGroupOptions[]")]),e._v(" ("),t("a",{attrs:{href:"../concepts/groups"}},[e._v("details")]),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("specifies groups of packages that need to be version bumped at the same time")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("groupChanges")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("false")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("will write multiple changes to a single changefile")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("hooks")])]),e._v(" "),t("td",[t("code",[e._v("HooksOptions")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("details"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("hooks for custom pre/post publish actions")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("ignorePatterns")])]),e._v(" "),t("td",[e._v("string[]")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("ignore changes in these files (minimatch patterns; negations not supported)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("package")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("specifies which package the command relates to (overrides change detection based on "),t("code",[e._v("git diff")]),e._v(")")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("prereleasePrefix")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("prerelease prefix for packages that are specified to receive a prerelease bump")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("publish")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("whether to publish to npm registry")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("push")])]),e._v(" "),t("td",[e._v("bool")]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("whether to push to the remote git branch")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("registry")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("target NPM registry to publish")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("retries")])]),e._v(" "),t("td",[e._v("number")]),e._v(" "),t("td",[t("code",[e._v("3")])]),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("number of retries for a package publish before failing")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("shouldPublish")])]),e._v(" "),t("td",[e._v("false | undefined")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("package")]),e._v(" "),t("td",[e._v("manually disable publishing of a package by beachball (does not work to force publishing)")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("tag")])]),e._v(" "),t("td",[e._v("string")]),e._v(" "),t("td",[t("code",[e._v("'latest'")])]),e._v(" "),t("td",[e._v("repo, package")]),e._v(" "),t("td",[e._v("dist-tag for npm when published")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("transform")])]),e._v(" "),t("td",[t("code",[e._v("TransformOptions")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/microsoft/beachball/blob/master/src/types/BeachballOptions.ts",target:"_blank",rel:"noopener noreferrer"}},[e._v("details"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("td"),e._v(" "),t("td",[e._v("repo")]),e._v(" "),t("td",[e._v("transformations for change files")])])])])])}),[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/assets/js/app.805017fe.js b/assets/js/app.c72d448a.js similarity index 97% rename from assets/js/app.805017fe.js rename to assets/js/app.c72d448a.js index 46697f73..5a5b1f80 100644 --- a/assets/js/app.805017fe.js +++ b/assets/js/app.c72d448a.js @@ -1,4 +1,4 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[0],[]]);!function(t){function e(e){for(var r,a,s=e[0],c=e[1],u=e[2],f=0,p=[];f
'};function o(t,e,n){return tn?n:t}function i(t){return 100*(-1+t)}n.configure=function(t){var e,n;for(e in t)void 0!==(n=t[e])&&t.hasOwnProperty(e)&&(r[e]=n);return this},n.status=null,n.set=function(t){var e=n.isStarted();t=o(t,r.minimum,1),n.status=1===t?null:t;var c=n.render(!e),u=c.querySelector(r.barSelector),l=r.speed,f=r.easing;return c.offsetWidth,a((function(e){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),s(u,function(t,e,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+i(t)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+i(t)+"%,0)"}:{"margin-left":i(t)+"%"}).transition="all "+e+"ms "+n,o}(t,l,f)),1===t?(s(c,{transition:"none",opacity:1}),c.offsetWidth,setTimeout((function(){s(c,{transition:"all "+l+"ms linear",opacity:0}),setTimeout((function(){n.remove(),e()}),l)}),l)):setTimeout(e,l)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var t=function(){setTimeout((function(){n.status&&(n.trickle(),t())}),r.trickleSpeed)};return r.trickle&&t(),this},n.done=function(t){return t||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(t){var e=n.status;return e?("number"!=typeof t&&(t=(1-e)*o(Math.random()*e,.1,.95)),e=o(e+t,0,.994),n.set(e)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},t=0,e=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===e&&n.start(),t++,e++,r.always((function(){0==--e?(t=0,n.done()):n.set((t-e)/t)})),this):this},n.render=function(t){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var e=document.createElement("div");e.id="nprogress",e.innerHTML=r.template;var o,a=e.querySelector(r.barSelector),c=t?"-100":i(n.status||0),l=document.querySelector(r.parent);return s(a,{transition:"all 0 linear",transform:"translate3d("+c+"%,0,0)"}),r.showSpinner||(o=e.querySelector(r.spinnerSelector))&&p(o),l!=document.body&&u(l,"nprogress-custom-parent"),l.appendChild(e),e},n.remove=function(){l(document.documentElement,"nprogress-busy"),l(document.querySelector(r.parent),"nprogress-custom-parent");var t=document.getElementById("nprogress");t&&p(t)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var t=document.body.style,e="WebkitTransform"in t?"Webkit":"MozTransform"in t?"Moz":"msTransform"in t?"ms":"OTransform"in t?"O":"";return e+"Perspective"in t?"translate3d":e+"Transform"in t?"translate":"margin"};var a=function(){var t=[];function e(){var n=t.shift();n&&n(e)}return function(n){t.push(n),1==t.length&&e()}}(),s=function(){var t=["Webkit","O","Moz","ms"],e={};function n(n){return n=n.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(t,e){return e.toUpperCase()})),e[n]||(e[n]=function(e){var n=document.body.style;if(e in n)return e;for(var r,o=t.length,i=e.charAt(0).toUpperCase()+e.slice(1);o--;)if((r=t[o]+i)in n)return r;return e}(n))}function r(t,e,r){e=n(e),t.style[e]=r}return function(t,e){var n,o,i=arguments;if(2==i.length)for(n in e)void 0!==(o=e[n])&&e.hasOwnProperty(n)&&r(t,n,o);else r(t,i[1],i[2])}}();function c(t,e){return("string"==typeof t?t:f(t)).indexOf(" "+e+" ")>=0}function u(t,e){var n=f(t),r=n+e;c(n,e)||(t.className=r.substring(1))}function l(t,e){var n,r=f(t);c(t,e)&&(n=r.replace(" "+e+" "," "),t.className=n.substring(1,n.length-1))}function f(t){return(" "+(t.className||"")+" ").replace(/\s+/gi," ")}function p(t){t&&t.parentNode&&t.parentNode.removeChild(t)}return n})?r.call(e,n,e,t):r)||(t.exports=o)},function(t,e,n){"use strict";n(147)},function(t,e,n){"use strict";var r=n(155),o=n(11),i=n(1),a=n(45),s=n(157),c=n(33),u=n(30),l=n(158),f=n(87),p=n(51),h=TypeError,d=function(t,e){this.stopped=t,this.result=e},v=d.prototype;t.exports=function(t,e,n){var m,g,y,b,_,w,x,O=n&&n.that,C=!(!n||!n.AS_ENTRIES),$=!(!n||!n.IS_RECORD),k=!(!n||!n.IS_ITERATOR),S=!(!n||!n.INTERRUPTED),j=r(e,O),E=function(t){return m&&p(m,"normal",t),new d(!0,t)},P=function(t){return C?(i(t),S?j(t[0],t[1],E):j(t[0],t[1])):S?j(t,E):j(t)};if($)m=t.iterator;else if(k)m=t;else{if(!(g=f(t)))throw new h(a(t)+" is not iterable");if(s(g)){for(y=0,b=c(t);b>y;y++)if((_=P(t[y]))&&u(v,_))return _;return new d(!1)}m=l(t,g)}for(w=$?t.next:m.next;!(x=o(w,m)).done;){try{_=P(x.value)}catch(t){p(m,"throw",t)}if("object"==typeof _&&_&&u(v,_))return _}return new d(!1)}},function(t,e,n){"use strict";var r=n(0),o=n(15),i=n(76),a=n(47);t.exports=function(t,e,n,s){s||(s={});var c=s.enumerable,u=void 0!==s.name?s.name:e;if(r(n)&&i(n,u,s),s.global)c?t[e]=n:a(e,n);else{try{s.unsafe?t[e]&&(c=!0):delete t[e]}catch(t){}c?t[e]=n:o.f(t,e,{value:n,enumerable:!1,configurable:!s.nonConfigurable,writable:!s.nonWritable})}return t}},function(t,e,n){"use strict";var r=n(44),o=TypeError;t.exports=function(t){if(r(t))throw new o("Can't call method on "+t);return t}},function(t,e,n){"use strict";t.exports=function(t){return null==t}},function(t,e,n){"use strict";var r=String;t.exports=function(t){try{return r(t)}catch(t){return"Object"}}},function(t,e,n){"use strict";var r=n(19),o=n(2),i=n(47),a=t.exports=o["__core-js_shared__"]||i("__core-js_shared__",{});(a.versions||(a.versions=[])).push({version:"3.39.0",mode:r?"pure":"global",copyright:"© 2014-2024 Denis Pushkarev (zloirock.ru)",license:"https://github.com/zloirock/core-js/blob/v3.39.0/LICENSE",source:"https://github.com/zloirock/core-js"})},function(t,e,n){"use strict";var r=n(2),o=Object.defineProperty;t.exports=function(t,e){try{o(r,t,{value:e,configurable:!0,writable:!0})}catch(n){r[t]=e}return e}},function(t,e,n){"use strict";var r=n(71),o=n(72),i=r("keys");t.exports=function(t){return i[t]||(i[t]=o(t))}},function(t,e,n){"use strict";t.exports={}},function(t,e,n){"use strict";t.exports=["constructor","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","toLocaleString","toString","valueOf"]},function(t,e,n){"use strict";var r=n(11),o=n(1),i=n(31);t.exports=function(t,e,n){var a,s;o(t);try{if(!(a=i(t,"return"))){if("throw"===e)throw n;return n}a=r(a,t)}catch(t){s=!0,a=t}if("throw"===e)throw n;if(s)throw a;return o(a),n}},function(t,e,n){var r=n(180),o=n(18),i=Object.prototype,a=i.hasOwnProperty,s=i.propertyIsEnumerable,c=r(function(){return arguments}())?r:function(t){return o(t)&&a.call(t,"callee")&&!s.call(t,"callee")};t.exports=c},function(t,e,n){var r=n(16)(n(12),"Map");t.exports=r},function(t,e){t.exports=function(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)}},function(t,e,n){var r=n(200),o=n(207),i=n(209),a=n(210),s=n(211);function c(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e-1&&t%1==0&&t<=9007199254740991}},function(t,e,n){var r=n(10),o=n(59),i=/\.|\[(?:[^[\]]*|(["'])(?:(?!\1)[^\\]|\\.)*?\1)\]/,a=/^\w*$/;t.exports=function(t,e){if(r(t))return!1;var n=typeof t;return!("number"!=n&&"symbol"!=n&&"boolean"!=n&&null!=t&&!o(t))||(a.test(t)||!i.test(t)||null!=e&&t in Object(e))}},function(t,e,n){var r=n(23),o=n(18);t.exports=function(t){return"symbol"==typeof t||o(t)&&"[object Symbol]"==r(t)}},function(t,e){t.exports=function(t){return t}},function(t,e,n){"use strict";n(271)},function(t,e,n){"use strict";n(154)},function(t,e,n){"use strict";var r=n(5),o=n(11),i=n(124),a=n(27),s=n(28),c=n(65),u=n(8),l=n(73),f=Object.getOwnPropertyDescriptor;e.f=r?f:function(t,e){if(t=s(t),e=c(e),l)try{return f(t,e)}catch(t){}if(u(t,e))return a(!o(i.f,t,e),t[e])}},function(t,e,n){"use strict";var r=n(4),o=n(3),i=n(24),a=Object,s=r("".split);t.exports=o((function(){return!a("z").propertyIsEnumerable(0)}))?function(t){return"String"===i(t)?s(t,""):a(t)}:a},function(t,e,n){"use strict";var r=n(125),o=n(66);t.exports=function(t){var e=r(t,"string");return o(e)?e:e+""}},function(t,e,n){"use strict";var r=n(29),o=n(0),i=n(30),a=n(67),s=Object;t.exports=a?function(t){return"symbol"==typeof t}:function(t){var e=r("Symbol");return o(e)&&i(e.prototype,s(t))}},function(t,e,n){"use strict";var r=n(68);t.exports=r&&!Symbol.sham&&"symbol"==typeof Symbol.iterator},function(t,e,n){"use strict";var r=n(69),o=n(3),i=n(2).String;t.exports=!!Object.getOwnPropertySymbols&&!o((function(){var t=Symbol("symbol detection");return!i(t)||!(Object(t)instanceof Symbol)||!Symbol.sham&&r&&r<41}))},function(t,e,n){"use strict";var r,o,i=n(2),a=n(70),s=i.process,c=i.Deno,u=s&&s.versions||c&&c.version,l=u&&u.v8;l&&(o=(r=l.split("."))[0]>0&&r[0]<4?1:+(r[0]+r[1])),!o&&a&&(!(r=a.match(/Edge\/(\d+)/))||r[1]>=74)&&(r=a.match(/Chrome\/(\d+)/))&&(o=+r[1]),t.exports=o},function(t,e,n){"use strict";var r=n(2).navigator,o=r&&r.userAgent;t.exports=o?String(o):""},function(t,e,n){"use strict";var r=n(46);t.exports=function(t,e){return r[t]||(r[t]=e||{})}},function(t,e,n){"use strict";var r=n(4),o=0,i=Math.random(),a=r(1..toString);t.exports=function(t){return"Symbol("+(void 0===t?"":t)+")_"+a(++o+i,36)}},function(t,e,n){"use strict";var r=n(5),o=n(3),i=n(74);t.exports=!r&&!o((function(){return 7!==Object.defineProperty(i("div"),"a",{get:function(){return 7}}).a}))},function(t,e,n){"use strict";var r=n(2),o=n(7),i=r.document,a=o(i)&&o(i.createElement);t.exports=function(t){return a?i.createElement(t):{}}},function(t,e,n){"use strict";var r=n(5),o=n(3);t.exports=r&&o((function(){return 42!==Object.defineProperty((function(){}),"prototype",{value:42,writable:!1}).prototype}))},function(t,e,n){"use strict";var r=n(4),o=n(3),i=n(0),a=n(8),s=n(5),c=n(127).CONFIGURABLE,u=n(128),l=n(77),f=l.enforce,p=l.get,h=String,d=Object.defineProperty,v=r("".slice),m=r("".replace),g=r([].join),y=s&&!o((function(){return 8!==d((function(){}),"length",{value:8}).length})),b=String(String).split("String"),_=t.exports=function(t,e,n){"Symbol("===v(h(e),0,7)&&(e="["+m(h(e),/^Symbol\(([^)]*)\).*$/,"$1")+"]"),n&&n.getter&&(e="get "+e),n&&n.setter&&(e="set "+e),(!a(t,"name")||c&&t.name!==e)&&(s?d(t,"name",{value:e,configurable:!0}):t.name=e),y&&n&&a(n,"arity")&&t.length!==n.arity&&d(t,"length",{value:n.arity});try{n&&a(n,"constructor")&&n.constructor?s&&d(t,"prototype",{writable:!1}):t.prototype&&(t.prototype=void 0)}catch(t){}var r=f(t);return a(r,"source")||(r.source=g(b,"string"==typeof e?e:"")),t};Function.prototype.toString=_((function(){return i(this)&&p(this).source||u(this)}),"toString")},function(t,e,n){"use strict";var r,o,i,a=n(129),s=n(2),c=n(7),u=n(20),l=n(8),f=n(46),p=n(48),h=n(49),d=s.TypeError,v=s.WeakMap;if(a||f.state){var m=f.state||(f.state=new v);m.get=m.get,m.has=m.has,m.set=m.set,r=function(t,e){if(m.has(t))throw new d("Object already initialized");return e.facade=t,m.set(t,e),e},o=function(t){return m.get(t)||{}},i=function(t){return m.has(t)}}else{var g=p("state");h[g]=!0,r=function(t,e){if(l(t,g))throw new d("Object already initialized");return e.facade=t,u(t,g,e),e},o=function(t){return l(t,g)?t[g]:{}},i=function(t){return l(t,g)}}t.exports={set:r,get:o,has:i,enforce:function(t){return i(t)?o(t):r(t,{})},getterFor:function(t){return function(e){var n;if(!c(e)||(n=o(e)).type!==t)throw new d("Incompatible receiver, "+t+" required");return n}}}},function(t,e,n){"use strict";var r=n(8),o=n(130),i=n(63),a=n(15);t.exports=function(t,e,n){for(var s=o(e),c=a.f,u=i.f,l=0;lu;)o(r,n=e[u++])&&(~a(l,n)||c(l,n));return l}},function(t,e,n){"use strict";var r=n(134);t.exports=function(t){var e=+t;return e!=e||0===e?0:r(e)}},function(t,e,n){"use strict";var r=n(8),o=n(0),i=n(32),a=n(48),s=n(139),c=a("IE_PROTO"),u=Object,l=u.prototype;t.exports=s?u.getPrototypeOf:function(t){var e=i(t);if(r(e,c))return e[c];var n=e.constructor;return o(n)&&e instanceof n?n.prototype:e instanceof u?l:null}},function(t,e,n){"use strict";var r,o,i,a=n(3),s=n(0),c=n(7),u=n(83),l=n(81),f=n(42),p=n(13),h=n(19),d=p("iterator"),v=!1;[].keys&&("next"in(i=[].keys())?(o=l(l(i)))!==Object.prototype&&(r=o):v=!0),!c(r)||a((function(){var t={};return r[d].call(t)!==t}))?r={}:h&&(r=u(r)),s(r[d])||f(r,d,(function(){return this})),t.exports={IteratorPrototype:r,BUGGY_SAFARI_ITERATORS:v}},function(t,e,n){"use strict";var r,o=n(1),i=n(141),a=n(50),s=n(49),c=n(143),u=n(74),l=n(48),f=l("IE_PROTO"),p=function(){},h=function(t){return" + diff --git a/cli/change.html b/cli/change.html index daa6fed8..8465d912 100644 --- a/cli/change.html +++ b/cli/change.html @@ -8,7 +8,7 @@ - + @@ -57,6 +57,6 @@ →

- + diff --git a/cli/check.html b/cli/check.html index 9fb1a06e..1184c43d 100644 --- a/cli/check.html +++ b/cli/check.html @@ -8,7 +8,7 @@ - + @@ -34,6 +34,6 @@ →

- + diff --git a/cli/options.html b/cli/options.html index c0182449..a56855f8 100644 --- a/cli/options.html +++ b/cli/options.html @@ -8,7 +8,7 @@ - + @@ -33,6 +33,6 @@ →

- + diff --git a/cli/publish.html b/cli/publish.html index f8101f24..fc5bcd07 100644 --- a/cli/publish.html +++ b/cli/publish.html @@ -8,7 +8,7 @@ - + @@ -35,6 +35,6 @@ →

- + diff --git a/cli/sync.html b/cli/sync.html index 07a658b3..ef135809 100644 --- a/cli/sync.html +++ b/cli/sync.html @@ -8,7 +8,7 @@ - + @@ -29,6 +29,6 @@

- + diff --git a/concepts/bump-algorithm.html b/concepts/bump-algorithm.html index 5a38a9e3..0c60ae3d 100644 --- a/concepts/bump-algorithm.html +++ b/concepts/bump-algorithm.html @@ -8,7 +8,7 @@ - + @@ -42,6 +42,6 @@ →

- + diff --git a/concepts/change-files.html b/concepts/change-files.html index 212b560f..29e35820 100644 --- a/concepts/change-files.html +++ b/concepts/change-files.html @@ -8,7 +8,7 @@ - + @@ -58,6 +58,6 @@ →

- + diff --git a/concepts/ci-integration.html b/concepts/ci-integration.html index bdd3da31..ff06125d 100644 --- a/concepts/ci-integration.html +++ b/concepts/ci-integration.html @@ -8,7 +8,7 @@ - + @@ -119,6 +119,6 @@ →

- + diff --git a/concepts/groups.html b/concepts/groups.html index dd380ddd..74f825a6 100644 --- a/concepts/groups.html +++ b/concepts/groups.html @@ -8,7 +8,7 @@ - + @@ -46,6 +46,6 @@ →

- + diff --git a/index.html b/index.html index 67b8ccb2..59478855 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ - + @@ -33,6 +33,6 @@

Synchronized in git and npm

keep your git and npm versions in sync in CI and local workflows

Generates Changelogs

same command will generate changelogs for your users

Automated Version Bumps

one command line to bump package(s) in your repo with semver

Single or Monorepo

compatible out of the box for single repo or monorepos

Pre-Publish Validation Checks

double and triple check git repo and npm registry before publish

Zero Config Versioning

no config is required to get started, do more in one line

MIT Licensed | Copyright © 2019-present Microsoft
- + diff --git a/overview/configuration.html b/overview/configuration.html index cace7eef..57917914 100644 --- a/overview/configuration.html +++ b/overview/configuration.html @@ -8,7 +8,7 @@ - + @@ -48,6 +48,6 @@ →

- + diff --git a/overview/getting-started.html b/overview/getting-started.html index 73d42a66..d0f7f102 100644 --- a/overview/getting-started.html +++ b/overview/getting-started.html @@ -8,7 +8,7 @@ - + @@ -33,6 +33,6 @@ →

- + diff --git a/overview/installation.html b/overview/installation.html index 45564a7d..66ef8982 100644 --- a/overview/installation.html +++ b/overview/installation.html @@ -8,7 +8,7 @@ - + @@ -44,6 +44,6 @@ →

- +