diff --git a/404.html b/404.html index 98bac42b..03d55d70 100644 --- a/404.html +++ b/404.html @@ -8,13 +8,13 @@ - +

404

How did we get here?
Take me home.
- + diff --git a/assets/js/24.e17b0ff9.js b/assets/js/24.1bceedac.js similarity index 99% rename from assets/js/24.e17b0ff9.js rename to assets/js/24.1bceedac.js index 80d910e1..933871b5 100644 --- a/assets/js/24.e17b0ff9.js +++ b/assets/js/24.1bceedac.js @@ -1 +1 @@ -(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 +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{351: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/25.5ec11fef.js b/assets/js/25.3ce83284.js similarity index 97% rename from assets/js/25.5ec11fef.js rename to assets/js/25.3ce83284.js index ed6f2e4e..7faee47c 100644 --- a/assets/js/25.5ec11fef.js +++ b/assets/js/25.3ce83284.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{350:function(e,t,a){"use strict";a.r(t);var s=a(17),o=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"check"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#check"}},[e._v("#")]),e._v(" "),t("code",[e._v("check")])]),e._v(" "),t("p",[e._v("It's recommended to enforce that "),t("a",{attrs:{href:"../concepts/change-files"}},[e._v("change files")]),e._v(" are included with each PR. This way, all changes are captured and affect semver appropriately.")]),e._v(" "),t("p",[e._v("To ensure that all changes are captured in change files, simply run:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ beachball check\n")])])]),t("p",[e._v("This command also checks for misconfigurations that would result in problems when attempting to publish.")]),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:"where-should-check-be-run"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#where-should-check-be-run"}},[e._v("#")]),e._v(" Where should "),t("code",[e._v("check")]),e._v(" be run?")]),e._v(" "),t("h4",{attrs:{id:"as-a-step-in-the-pr-review-gate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#as-a-step-in-the-pr-review-gate"}},[e._v("#")]),e._v(" As a step in the PR review gate")]),e._v(" "),t("p",[e._v("See the "),t("a",{attrs:{href:"../concepts/change-files#validating-change-files"}},[e._v("change files page")]),e._v(" for how to set this up.")]),e._v(" "),t("h4",{attrs:{id:"as-git-hook-optional"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#as-git-hook-optional"}},[e._v("#")]),e._v(" As git hook (optional)")]),e._v(" "),t("p",[e._v("For a reference about git hooks, take a look at "),t("a",{attrs:{href:"https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks",target:"_blank",rel:"noopener noreferrer"}},[e._v("this documentation"),t("OutboundLink")],1),e._v(". This hook would typically be run pre-push.")]),e._v(" "),t("p",[e._v("While running "),t("code",[e._v("beachball check")]),e._v(" before push may seem appealing, it has some downsides: it will substantially slow down running "),t("code",[e._v("git push")]),e._v(" and could be annoying when pushing work-in-progress changes to remote branches. Our experience with repos enabling this hook is that it's often quickly removed due to developer feedback.")])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{348:function(e,t,a){"use strict";a.r(t);var s=a(17),o=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"check"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#check"}},[e._v("#")]),e._v(" "),t("code",[e._v("check")])]),e._v(" "),t("p",[e._v("It's recommended to enforce that "),t("a",{attrs:{href:"../concepts/change-files"}},[e._v("change files")]),e._v(" are included with each PR. This way, all changes are captured and affect semver appropriately.")]),e._v(" "),t("p",[e._v("To ensure that all changes are captured in change files, simply run:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ beachball check\n")])])]),t("p",[e._v("This command also checks for misconfigurations that would result in problems when attempting to publish.")]),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:"where-should-check-be-run"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#where-should-check-be-run"}},[e._v("#")]),e._v(" Where should "),t("code",[e._v("check")]),e._v(" be run?")]),e._v(" "),t("h4",{attrs:{id:"as-a-step-in-the-pr-review-gate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#as-a-step-in-the-pr-review-gate"}},[e._v("#")]),e._v(" As a step in the PR review gate")]),e._v(" "),t("p",[e._v("See the "),t("a",{attrs:{href:"../concepts/change-files#validating-change-files"}},[e._v("change files page")]),e._v(" for how to set this up.")]),e._v(" "),t("h4",{attrs:{id:"as-git-hook-optional"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#as-git-hook-optional"}},[e._v("#")]),e._v(" As git hook (optional)")]),e._v(" "),t("p",[e._v("For a reference about git hooks, take a look at "),t("a",{attrs:{href:"https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks",target:"_blank",rel:"noopener noreferrer"}},[e._v("this documentation"),t("OutboundLink")],1),e._v(". This hook would typically be run pre-push.")]),e._v(" "),t("p",[e._v("While running "),t("code",[e._v("beachball check")]),e._v(" before push may seem appealing, it has some downsides: it will substantially slow down running "),t("code",[e._v("git push")]),e._v(" and could be annoying when pushing work-in-progress changes to remote branches. Our experience with repos enabling this hook is that it's often quickly removed due to developer feedback.")])])}),[],!1,null,null,null);t.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/31.f5c386f3.js b/assets/js/31.8384c20d.js similarity index 99% rename from assets/js/31.f5c386f3.js rename to assets/js/31.8384c20d.js index b5df0979..b4316d48 100644 --- a/assets/js/31.f5c386f3.js +++ b/assets/js/31.8384c20d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{355:function(e,t,s){"use strict";s.r(t);var n=s(17),a=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"ci-integration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ci-integration"}},[e._v("#")]),e._v(" CI Integration")]),e._v(" "),t("p",[e._v("There are two parts to CI integration with "),t("code",[e._v("beachball")]),e._v(":")]),e._v(" "),t("ol",[t("li",[t("a",{attrs:{href:"./change-files#validating-change-files"}},[e._v("Add a PR build step")]),e._v(" to call "),t("code",[e._v("beachball check")]),e._v(" to validate that change files are included.")]),e._v(" "),t("li",[e._v("Add a release build step to call "),t("code",[e._v("beachball publish")]),e._v(" to publish to npm and push back to git (this page).")])]),e._v(" "),t("p",[e._v("To automate the bumping of package versions based on change files, you'll need to configure your release workflow/pipeline so that "),t("code",[e._v("beachball publish")]),e._v(" has write access to the git repo and npm registry. The exact steps will vary between CI systems, but general concepts as well as steps for some common setups are outlined below.")]),e._v(" "),t("h2",{attrs:{id:"authentication"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[e._v("#")]),e._v(" Authentication")]),e._v(" "),t("p",[e._v("Automated publishing from a GitHub repo to the public npm registry ("),t("code",[e._v("registry.npmjs.org")]),e._v(") typically uses personal access tokens for authentication. These tokens are stored as secrets in your CI system. You should ensure that these secrets are only available to release builds.")]),e._v(" "),t("p",[e._v("For Azure DevOps repos publishing to a private registry, there are other possible approaches (such as using a service account with credentials stored in a key vault) which are not currently covered by these docs.")]),e._v(" "),t("h3",{attrs:{id:"generating-tokens"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#generating-tokens"}},[e._v("#")]),e._v(" Generating tokens")]),e._v(" "),t("h4",{attrs:{id:"npm-token"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#npm-token"}},[e._v("#")]),e._v(" npm token")]),e._v(" "),t("p",[e._v("If publishing to the public npm registry ("),t("code",[e._v("registry.npmjs.org")]),e._v("), "),t("a",{attrs:{href:"https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website",target:"_blank",rel:"noopener noreferrer"}},[e._v("create a granular access token"),t("OutboundLink")],1),e._v(" with write access to only the relevant package(s) and/or scope(s). Classic automation tokens are not recommended due to their overly broad permissions.")]),e._v(" "),t("h4",{attrs:{id:"github-token"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#github-token"}},[e._v("#")]),e._v(" GitHub token")]),e._v(" "),t("p",[e._v("You should use "),t("a",{attrs:{href:"https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule",target:"_blank",rel:"noopener noreferrer"}},[e._v("branch protection"),t("OutboundLink")],1),e._v(" for your "),t("code",[e._v("main")]),e._v("/"),t("code",[e._v("master")]),e._v(" branch, but this creates some difficulties for pushing changes back during automated publishing.")]),e._v(" "),t("p",[e._v("The main way to allow "),t("code",[e._v("beachball")]),e._v(" to push back to a repo with branch protections is by using a "),t("a",{attrs:{href:"https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#personal-access-tokens-classic",target:"_blank",rel:"noopener noreferrer"}},[e._v("classic personal access token"),t("OutboundLink")],1),e._v(" with "),t("code",[e._v("repo")]),e._v(" permissions. (If the repo is part of an organization that uses SAML single sign-on (SSO), be sure to "),t("a",{attrs:{href:"https://docs.github.com/en/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on",target:"_blank",rel:"noopener noreferrer"}},[e._v("authorize the token for SSO access"),t("OutboundLink")],1),e._v(".) Since classic PATs have broad permissions, they must only be accessible to release builds—"),t("a",{attrs:{href:"#storing-tokens"}},[e._v("instructions below")]),e._v(".")]),e._v(" "),t("p",[e._v('An alternative approach is creating a classic PAT with a "machine user" account. Create a new account with an alternate email or '),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Email_address#Subaddressing",target:"_blank",rel:"noopener noreferrer"}},[e._v("subaddress"),t("OutboundLink")],1),e._v(" ("),t("code",[e._v("+")]),e._v(' address), give it contributor permissions to only this repo, and add it under "Restrict who can push to matching branches" in the branch protection rule.')]),e._v(" "),t("p",[e._v("(It's unclear if/when branch policy bypass support will be added for "),t("a",{attrs:{href:"https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-fine-grained-personal-access-token",target:"_blank",rel:"noopener noreferrer"}},[e._v("fine-grained PATs"),t("OutboundLink")],1),e._v("; it's been "),t("a",{attrs:{href:"https://github.com/community/community/discussions/36441?sort=top#discussioncomment-4602435",target:"_blank",rel:"noopener noreferrer"}},[e._v("requested"),t("OutboundLink")],1),e._v(" by users with no response and doesn't seem to be on the "),t("a",{attrs:{href:"https://github.com/orgs/github/projects/4247/views/1",target:"_blank",rel:"noopener noreferrer"}},[e._v("public roadmap"),t("OutboundLink")],1),e._v(". The "),t("a",{attrs:{href:"https://docs.github.com/en/actions/security-guides/automatic-token-authentication",target:"_blank",rel:"noopener noreferrer"}},[e._v("built-in "),t("code",[e._v("GITHUB_TOKEN")]),t("OutboundLink")],1),e._v(" won't work for the same reason.)")]),e._v(" "),t("h3",{attrs:{id:"storing-tokens"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#storing-tokens"}},[e._v("#")]),e._v(" Storing tokens")]),e._v(" "),t("h4",{attrs:{id:"secrets-github-actions"}},[e._v("GitHub Actions")]),e._v(" "),t("p",[e._v("To restrict secret access to appropriate branches, use an "),t("strong",[t("a",{attrs:{href:"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment",target:"_blank",rel:"noopener noreferrer"}},[e._v("environment"),t("OutboundLink")],1)]),e._v(". (The docs for environments focus on cloud deployments or resources, but environments can also be used only for secret storage.)")]),e._v(" "),t("ol",[t("li",[t("a",{attrs:{href:"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#creating-an-environment",target:"_blank",rel:"noopener noreferrer"}},[e._v("Create an environment"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Restrict "),t("a",{attrs:{href:"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches",target:"_blank",rel:"noopener noreferrer"}},[e._v("deployment branches"),t("OutboundLink")],1),e._v(' to "Selected branches" and add a rule to allow only your release branch(es) (often '),t("code",[e._v("main")]),e._v("/"),t("code",[e._v("master")]),e._v(").")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment",target:"_blank",rel:"noopener noreferrer"}},[e._v("Add secrets"),t("OutboundLink")],1),e._v(" for the npm and GitHub tokens.")]),e._v(" "),t("li",[e._v("To "),t("a",{attrs:{href:"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment",target:"_blank",rel:"noopener noreferrer"}},[e._v("use the environment"),t("OutboundLink")],1),e._v(", add a key "),t("code",[e._v("environment: your-env-name")]),e._v(" in your release workflow job. (Full example below.)")])]),e._v(" "),t("h4",{attrs:{id:"secrets-azure-pipelines"}},[e._v("Azure Pipelines")]),e._v(" "),t("p",[e._v("There are a couple of options here:")]),e._v(" "),t("ul",[t("li",[e._v("Use "),t("a",{attrs:{href:"https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#secret-variables",target:"_blank",rel:"noopener noreferrer"}},[e._v("secret variables in your release pipeline"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Use "),t("a",{attrs:{href:"https://learn.microsoft.com/en-us/azure/devops/pipelines/library/variable-groups?view=azure-devops&tabs=classic",target:"_blank",rel:"noopener noreferrer"}},[e._v("secrets in a variable group"),t("OutboundLink")],1),e._v(", which can optionally be linked to a key vault. Ensure that this variable group is only accessible to your release pipeline.")])]),e._v(" "),t("h2",{attrs:{id:"setting-options-for-publishing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-options-for-publishing"}},[e._v("#")]),e._v(" Setting options for publishing")]),e._v(" "),t("p",[e._v("If you're passing any custom options besides the npm token to "),t("code",[e._v("beachball publish")]),e._v(", it's recommended to set them in either the "),t("code",[e._v("beachball")]),e._v(" config (if they don't interfere with other commands), or a "),t("code",[e._v("package.json")]),e._v(" script (if specific to "),t("code",[e._v("publish")]),e._v(").")]),e._v(" "),t("p",[e._v("For example, the following script could be used for publishing public scoped packages:")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"scripts"')]),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 property"}},[e._v('"release"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"beachball publish --access public"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("If you're publishing to a private feed, "),t("code",[e._v("registry")]),e._v(" should be set in the overall "),t("code",[e._v("beachball")]),e._v(" config, since it's also used by the "),t("code",[e._v("sync")]),e._v(" command. For example, if your beachball config is in the root "),t("code",[e._v("package.json")]),e._v(" (or it works the same in a config file):")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"beachball"')]),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 property"}},[e._v('"registry"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"https://pkgs.dev.azure.com/some-org/_packaging/some-feed/npm/registry/"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("h2",{attrs:{id:"publishing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#publishing"}},[e._v("#")]),e._v(" Publishing")]),e._v(" "),t("p",[e._v("The exact publishing setup will vary depending on your CI setup, but the overall steps are as follows:")]),e._v(" "),t("ol",[t("li",[e._v("Ensure the git user name and email are set, or git will reject the commit. Somewhere in your pipeline:"),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" config user.name "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"someone"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" config user.email "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"someone@example.com"')]),e._v("\n")])])])]),e._v(" "),t("li",[e._v("Set up git authentication. This could use tokens (covered below), SSH keys, or some other non-interactive method.")]),e._v(" "),t("li",[e._v("Set up npm authentication. This could use tokens passed on the command line (covered below), tokens set in "),t("code",[e._v(".npmrc")]),e._v(", or some other method.")]),e._v(" "),t("li",[e._v("Run "),t("code",[e._v("beachball publish")]),e._v("!")])]),e._v(" "),t("h3",{attrs:{id:"github-repo-github-actions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#github-repo-github-actions"}},[e._v("#")]),e._v(" GitHub repo + GitHub Actions")]),e._v(" "),t("p",[e._v("Here's a sample setup for publishing from a GitHub repo using GitHub actions. The environment, secret, and script names can be modified as you prefer.")]),e._v(" "),t("p",[e._v("This sample assumes the following:")]),e._v(" "),t("ul",[t("li",[e._v("An environment called "),t("code",[e._v("release")]),e._v(" (set up "),t("a",{attrs:{href:"#secrets-github-actions"}},[e._v("as described above")]),e._v(") with the following secrets:\n"),t("ul",[t("li",[t("code",[e._v("REPO_PAT")]),e._v(": A GitHub classic personal access token with admin access ("),t("a",{attrs:{href:"#generating-a-github-token"}},[e._v("as described above")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("NPM_TOKEN")]),e._v(": An npm token with write access to the package(s) and/or scope(s), such as a "),t("a",{attrs:{href:"#generating-an-npm-token"}},[e._v("fine-grained token for public npm")])])])]),e._v(" "),t("li",[e._v("A repo root "),t("code",[e._v("package.json")]),e._v(" script "),t("code",[e._v("release")]),e._v(" which runs "),t("code",[e._v("beachball publish")])]),e._v(" "),t("li",[e._v("The build is running on a Linux/Mac agent. (This could be easily adapted to a Windows agent with different syntax in the commands.)")])]),e._v(" "),t("p",[e._v("Note that in GitHub Actions, it's easiest to set up authentication if you set "),t("code",[e._v("persist-credentials: false")]),e._v(" when checking out code.")]),e._v(" "),t("div",{staticClass:"language-yml extra-class"},[t("pre",{pre:!0,attrs:{class:"language-yml"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Example trigger configurations (choose one or more, or another setup)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# on:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release on push to main")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# push:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# branches: [main]")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release daily (see https://crontab-generator.org/ for help with schedules)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# schedule:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# - cron: '0 8 * * *'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release on manual trigger (can be used alone or with other options)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# workflow_dispatch:")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("environment")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" release\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Variable syntax below assumes Linux/Mac but could be easily adapted to Windows")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("runs-on")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" ubuntu"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v("latest\n\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("steps")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Check out code\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("uses")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" actions/checkout@v3\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("with")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Prevent the action from storing credentials in a way that's hard to override")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("persist-credentials")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean important"}},[e._v("false")]),e._v("\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# ... Other steps to prepare for publishing (install, build, test, etc) ...")]),e._v("\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set the name, email, and URL with PAT")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Set git credentials\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("run")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("|")]),t("span",{pre:!0,attrs:{class:"token scalar string"}},[e._v('\n git config user.name "someone"\n git config user.email "someone@example.com"\n git remote set-url origin "https://$REPO_PAT@github.com/your-org/your-repo"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("env")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("REPO_PAT")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" $"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" secrets.REPO_PAT "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Pass the token on the command line for publishing")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Publish\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("run")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" npm run release "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v('token "$NPM_TOKEN"\n '),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("env")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("NPM_TOKEN")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" $"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" secrets.NPM_TOKEN "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("h3",{attrs:{id:"github-repo-azure-pipelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#github-repo-azure-pipelines"}},[e._v("#")]),e._v(" GitHub repo + Azure Pipelines")]),e._v(" "),t("p",[e._v("Here's a sample setup for publishing from a GitHub repo using Azure Pipelines. The environment, secret, and script names can be modified as you prefer.")]),e._v(" "),t("p",[e._v("This sample assumes the following:")]),e._v(" "),t("ul",[t("li",[e._v("A variable group called "),t("code",[e._v("Beachball secrets")]),e._v(" (set up "),t("a",{attrs:{href:"#secrets-azure-pipelines"}},[e._v("as described above")]),e._v(") with the following secrets:\n"),t("ul",[t("li",[t("code",[e._v("GITHUB_PAT")]),e._v(": A GitHub classic personal access token with admin access ("),t("a",{attrs:{href:"#generating-a-github-token"}},[e._v("as described above")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("NPM_TOKEN")]),e._v(": An npm token with write access to the package(s) and/or scope(s), such as a "),t("a",{attrs:{href:"#generating-an-npm-token"}},[e._v("fine-grained token for public npm")])])])]),e._v(" "),t("li",[e._v("A repo root "),t("code",[e._v("package.json")]),e._v(" script "),t("code",[e._v("release")]),e._v(" which runs "),t("code",[e._v("beachball publish")])]),e._v(" "),t("li",[e._v("The build is running on a Linux/Mac agent. (This could be easily adapted to a Windows agent with different syntax in the commands.)")])]),e._v(" "),t("div",{staticClass:"language-yml extra-class"},[t("pre",{pre:!0,attrs:{class:"language-yml"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Example trigger configurations (choose one or more, or another setup)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("#")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release on push to main")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# trigger: [main]")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("#")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release on a schedule")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # https://docs.microsoft.com/en-us/azure/devops/pipelines/build/triggers?tabs=yaml&view=azure-devops#supported-cron-syntax")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# schedules:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# - cron: '0 8 * * *'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# branches:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# include: [main]")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# This group should only be accessible to the release pipeline")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("variables")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("group")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Beachball secrets\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Variable syntax below assumes Linux/Mac but could be easily adapted to Windows")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("pool")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("vmImage")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" ubuntu"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v("latest\n\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("steps")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# ... Other steps to set up repo and prepare for publishing (install, build, test, etc) ...")]),e._v("\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set the name, email, and URL with PAT")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("script")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("|")]),t("span",{pre:!0,attrs:{class:"token scalar string"}},[e._v('\n git config user.name "someone"\n git config user.email "someone@example.com"\n git remote set-url origin "https://$(REPO_PAT)@github.com/your-org/your-repo"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Set git credentials\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Pass the token on the command line for publishing")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("script")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" npm run release "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v('token "$(NPM_TOKEN)"\n '),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Publish\n")])])]),t("h3",{attrs:{id:"azure-repos-azure-pipelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#azure-repos-azure-pipelines"}},[e._v("#")]),e._v(" Azure Repos + Azure Pipelines")]),e._v(" "),t("p",[e._v("This should be very similar to the GitHub version, aside from possibly the authentication method. You could potentially use personal access tokens for git and npm feed authentication (similar to above), or other methods are available which aren't currently covered here.")]),e._v(" "),t("p",[e._v("If you're publishing to a private Azure Artifacts npm feed, be sure to set "),t("code",[e._v("registry")]),e._v(" in the "),t("code",[e._v("beachball")]),e._v(" config "),t("a",{attrs:{href:"#setting-options-for-publishing"}},[e._v("as described above")]),e._v(".")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{354:function(e,t,s){"use strict";s.r(t);var n=s(17),a=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"ci-integration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ci-integration"}},[e._v("#")]),e._v(" CI Integration")]),e._v(" "),t("p",[e._v("There are two parts to CI integration with "),t("code",[e._v("beachball")]),e._v(":")]),e._v(" "),t("ol",[t("li",[t("a",{attrs:{href:"./change-files#validating-change-files"}},[e._v("Add a PR build step")]),e._v(" to call "),t("code",[e._v("beachball check")]),e._v(" to validate that change files are included.")]),e._v(" "),t("li",[e._v("Add a release build step to call "),t("code",[e._v("beachball publish")]),e._v(" to publish to npm and push back to git (this page).")])]),e._v(" "),t("p",[e._v("To automate the bumping of package versions based on change files, you'll need to configure your release workflow/pipeline so that "),t("code",[e._v("beachball publish")]),e._v(" has write access to the git repo and npm registry. The exact steps will vary between CI systems, but general concepts as well as steps for some common setups are outlined below.")]),e._v(" "),t("h2",{attrs:{id:"authentication"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[e._v("#")]),e._v(" Authentication")]),e._v(" "),t("p",[e._v("Automated publishing from a GitHub repo to the public npm registry ("),t("code",[e._v("registry.npmjs.org")]),e._v(") typically uses personal access tokens for authentication. These tokens are stored as secrets in your CI system. You should ensure that these secrets are only available to release builds.")]),e._v(" "),t("p",[e._v("For Azure DevOps repos publishing to a private registry, there are other possible approaches (such as using a service account with credentials stored in a key vault) which are not currently covered by these docs.")]),e._v(" "),t("h3",{attrs:{id:"generating-tokens"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#generating-tokens"}},[e._v("#")]),e._v(" Generating tokens")]),e._v(" "),t("h4",{attrs:{id:"npm-token"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#npm-token"}},[e._v("#")]),e._v(" npm token")]),e._v(" "),t("p",[e._v("If publishing to the public npm registry ("),t("code",[e._v("registry.npmjs.org")]),e._v("), "),t("a",{attrs:{href:"https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website",target:"_blank",rel:"noopener noreferrer"}},[e._v("create a granular access token"),t("OutboundLink")],1),e._v(" with write access to only the relevant package(s) and/or scope(s). Classic automation tokens are not recommended due to their overly broad permissions.")]),e._v(" "),t("h4",{attrs:{id:"github-token"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#github-token"}},[e._v("#")]),e._v(" GitHub token")]),e._v(" "),t("p",[e._v("You should use "),t("a",{attrs:{href:"https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule",target:"_blank",rel:"noopener noreferrer"}},[e._v("branch protection"),t("OutboundLink")],1),e._v(" for your "),t("code",[e._v("main")]),e._v("/"),t("code",[e._v("master")]),e._v(" branch, but this creates some difficulties for pushing changes back during automated publishing.")]),e._v(" "),t("p",[e._v("The main way to allow "),t("code",[e._v("beachball")]),e._v(" to push back to a repo with branch protections is by using a "),t("a",{attrs:{href:"https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#personal-access-tokens-classic",target:"_blank",rel:"noopener noreferrer"}},[e._v("classic personal access token"),t("OutboundLink")],1),e._v(" with "),t("code",[e._v("repo")]),e._v(" permissions. (If the repo is part of an organization that uses SAML single sign-on (SSO), be sure to "),t("a",{attrs:{href:"https://docs.github.com/en/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on",target:"_blank",rel:"noopener noreferrer"}},[e._v("authorize the token for SSO access"),t("OutboundLink")],1),e._v(".) Since classic PATs have broad permissions, they must only be accessible to release builds—"),t("a",{attrs:{href:"#storing-tokens"}},[e._v("instructions below")]),e._v(".")]),e._v(" "),t("p",[e._v('An alternative approach is creating a classic PAT with a "machine user" account. Create a new account with an alternate email or '),t("a",{attrs:{href:"https://en.wikipedia.org/wiki/Email_address#Subaddressing",target:"_blank",rel:"noopener noreferrer"}},[e._v("subaddress"),t("OutboundLink")],1),e._v(" ("),t("code",[e._v("+")]),e._v(' address), give it contributor permissions to only this repo, and add it under "Restrict who can push to matching branches" in the branch protection rule.')]),e._v(" "),t("p",[e._v("(It's unclear if/when branch policy bypass support will be added for "),t("a",{attrs:{href:"https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-fine-grained-personal-access-token",target:"_blank",rel:"noopener noreferrer"}},[e._v("fine-grained PATs"),t("OutboundLink")],1),e._v("; it's been "),t("a",{attrs:{href:"https://github.com/community/community/discussions/36441?sort=top#discussioncomment-4602435",target:"_blank",rel:"noopener noreferrer"}},[e._v("requested"),t("OutboundLink")],1),e._v(" by users with no response and doesn't seem to be on the "),t("a",{attrs:{href:"https://github.com/orgs/github/projects/4247/views/1",target:"_blank",rel:"noopener noreferrer"}},[e._v("public roadmap"),t("OutboundLink")],1),e._v(". The "),t("a",{attrs:{href:"https://docs.github.com/en/actions/security-guides/automatic-token-authentication",target:"_blank",rel:"noopener noreferrer"}},[e._v("built-in "),t("code",[e._v("GITHUB_TOKEN")]),t("OutboundLink")],1),e._v(" won't work for the same reason.)")]),e._v(" "),t("h3",{attrs:{id:"storing-tokens"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#storing-tokens"}},[e._v("#")]),e._v(" Storing tokens")]),e._v(" "),t("h4",{attrs:{id:"secrets-github-actions"}},[e._v("GitHub Actions")]),e._v(" "),t("p",[e._v("To restrict secret access to appropriate branches, use an "),t("strong",[t("a",{attrs:{href:"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment",target:"_blank",rel:"noopener noreferrer"}},[e._v("environment"),t("OutboundLink")],1)]),e._v(". (The docs for environments focus on cloud deployments or resources, but environments can also be used only for secret storage.)")]),e._v(" "),t("ol",[t("li",[t("a",{attrs:{href:"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#creating-an-environment",target:"_blank",rel:"noopener noreferrer"}},[e._v("Create an environment"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Restrict "),t("a",{attrs:{href:"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches",target:"_blank",rel:"noopener noreferrer"}},[e._v("deployment branches"),t("OutboundLink")],1),e._v(' to "Selected branches" and add a rule to allow only your release branch(es) (often '),t("code",[e._v("main")]),e._v("/"),t("code",[e._v("master")]),e._v(").")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment",target:"_blank",rel:"noopener noreferrer"}},[e._v("Add secrets"),t("OutboundLink")],1),e._v(" for the npm and GitHub tokens.")]),e._v(" "),t("li",[e._v("To "),t("a",{attrs:{href:"https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment",target:"_blank",rel:"noopener noreferrer"}},[e._v("use the environment"),t("OutboundLink")],1),e._v(", add a key "),t("code",[e._v("environment: your-env-name")]),e._v(" in your release workflow job. (Full example below.)")])]),e._v(" "),t("h4",{attrs:{id:"secrets-azure-pipelines"}},[e._v("Azure Pipelines")]),e._v(" "),t("p",[e._v("There are a couple of options here:")]),e._v(" "),t("ul",[t("li",[e._v("Use "),t("a",{attrs:{href:"https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#secret-variables",target:"_blank",rel:"noopener noreferrer"}},[e._v("secret variables in your release pipeline"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("Use "),t("a",{attrs:{href:"https://learn.microsoft.com/en-us/azure/devops/pipelines/library/variable-groups?view=azure-devops&tabs=classic",target:"_blank",rel:"noopener noreferrer"}},[e._v("secrets in a variable group"),t("OutboundLink")],1),e._v(", which can optionally be linked to a key vault. Ensure that this variable group is only accessible to your release pipeline.")])]),e._v(" "),t("h2",{attrs:{id:"setting-options-for-publishing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setting-options-for-publishing"}},[e._v("#")]),e._v(" Setting options for publishing")]),e._v(" "),t("p",[e._v("If you're passing any custom options besides the npm token to "),t("code",[e._v("beachball publish")]),e._v(", it's recommended to set them in either the "),t("code",[e._v("beachball")]),e._v(" config (if they don't interfere with other commands), or a "),t("code",[e._v("package.json")]),e._v(" script (if specific to "),t("code",[e._v("publish")]),e._v(").")]),e._v(" "),t("p",[e._v("For example, the following script could be used for publishing public scoped packages:")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"scripts"')]),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 property"}},[e._v('"release"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"beachball publish --access public"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("If you're publishing to a private feed, "),t("code",[e._v("registry")]),e._v(" should be set in the overall "),t("code",[e._v("beachball")]),e._v(" config, since it's also used by the "),t("code",[e._v("sync")]),e._v(" command. For example, if your beachball config is in the root "),t("code",[e._v("package.json")]),e._v(" (or it works the same in a config file):")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"beachball"')]),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 property"}},[e._v('"registry"')]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"https://pkgs.dev.azure.com/some-org/_packaging/some-feed/npm/registry/"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("h2",{attrs:{id:"publishing"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#publishing"}},[e._v("#")]),e._v(" Publishing")]),e._v(" "),t("p",[e._v("The exact publishing setup will vary depending on your CI setup, but the overall steps are as follows:")]),e._v(" "),t("ol",[t("li",[e._v("Ensure the git user name and email are set, or git will reject the commit. Somewhere in your pipeline:"),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" config user.name "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"someone"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" config user.email "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"someone@example.com"')]),e._v("\n")])])])]),e._v(" "),t("li",[e._v("Set up git authentication. This could use tokens (covered below), SSH keys, or some other non-interactive method.")]),e._v(" "),t("li",[e._v("Set up npm authentication. This could use tokens passed on the command line (covered below), tokens set in "),t("code",[e._v(".npmrc")]),e._v(", or some other method.")]),e._v(" "),t("li",[e._v("Run "),t("code",[e._v("beachball publish")]),e._v("!")])]),e._v(" "),t("h3",{attrs:{id:"github-repo-github-actions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#github-repo-github-actions"}},[e._v("#")]),e._v(" GitHub repo + GitHub Actions")]),e._v(" "),t("p",[e._v("Here's a sample setup for publishing from a GitHub repo using GitHub actions. The environment, secret, and script names can be modified as you prefer.")]),e._v(" "),t("p",[e._v("This sample assumes the following:")]),e._v(" "),t("ul",[t("li",[e._v("An environment called "),t("code",[e._v("release")]),e._v(" (set up "),t("a",{attrs:{href:"#secrets-github-actions"}},[e._v("as described above")]),e._v(") with the following secrets:\n"),t("ul",[t("li",[t("code",[e._v("REPO_PAT")]),e._v(": A GitHub classic personal access token with admin access ("),t("a",{attrs:{href:"#generating-a-github-token"}},[e._v("as described above")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("NPM_TOKEN")]),e._v(": An npm token with write access to the package(s) and/or scope(s), such as a "),t("a",{attrs:{href:"#generating-an-npm-token"}},[e._v("fine-grained token for public npm")])])])]),e._v(" "),t("li",[e._v("A repo root "),t("code",[e._v("package.json")]),e._v(" script "),t("code",[e._v("release")]),e._v(" which runs "),t("code",[e._v("beachball publish")])]),e._v(" "),t("li",[e._v("The build is running on a Linux/Mac agent. (This could be easily adapted to a Windows agent with different syntax in the commands.)")])]),e._v(" "),t("p",[e._v("Note that in GitHub Actions, it's easiest to set up authentication if you set "),t("code",[e._v("persist-credentials: false")]),e._v(" when checking out code.")]),e._v(" "),t("div",{staticClass:"language-yml extra-class"},[t("pre",{pre:!0,attrs:{class:"language-yml"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Example trigger configurations (choose one or more, or another setup)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# on:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release on push to main")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# push:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# branches: [main]")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release daily (see https://crontab-generator.org/ for help with schedules)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# schedule:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# - cron: '0 8 * * *'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release on manual trigger (can be used alone or with other options)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# workflow_dispatch:")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("environment")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" release\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Variable syntax below assumes Linux/Mac but could be easily adapted to Windows")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("runs-on")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" ubuntu"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v("latest\n\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("steps")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Check out code\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("uses")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" actions/checkout@v3\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("with")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Prevent the action from storing credentials in a way that's hard to override")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("persist-credentials")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean important"}},[e._v("false")]),e._v("\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# ... Other steps to prepare for publishing (install, build, test, etc) ...")]),e._v("\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set the name, email, and URL with PAT")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Set git credentials\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("run")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("|")]),t("span",{pre:!0,attrs:{class:"token scalar string"}},[e._v('\n git config user.name "someone"\n git config user.email "someone@example.com"\n git remote set-url origin "https://$REPO_PAT@github.com/your-org/your-repo"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("env")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("REPO_PAT")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" $"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" secrets.REPO_PAT "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Pass the token on the command line for publishing")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Publish\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("run")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" npm run release "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v('token "$NPM_TOKEN"\n '),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("env")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("NPM_TOKEN")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" $"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" secrets.NPM_TOKEN "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("h3",{attrs:{id:"github-repo-azure-pipelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#github-repo-azure-pipelines"}},[e._v("#")]),e._v(" GitHub repo + Azure Pipelines")]),e._v(" "),t("p",[e._v("Here's a sample setup for publishing from a GitHub repo using Azure Pipelines. The environment, secret, and script names can be modified as you prefer.")]),e._v(" "),t("p",[e._v("This sample assumes the following:")]),e._v(" "),t("ul",[t("li",[e._v("A variable group called "),t("code",[e._v("Beachball secrets")]),e._v(" (set up "),t("a",{attrs:{href:"#secrets-azure-pipelines"}},[e._v("as described above")]),e._v(") with the following secrets:\n"),t("ul",[t("li",[t("code",[e._v("GITHUB_PAT")]),e._v(": A GitHub classic personal access token with admin access ("),t("a",{attrs:{href:"#generating-a-github-token"}},[e._v("as described above")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("NPM_TOKEN")]),e._v(": An npm token with write access to the package(s) and/or scope(s), such as a "),t("a",{attrs:{href:"#generating-an-npm-token"}},[e._v("fine-grained token for public npm")])])])]),e._v(" "),t("li",[e._v("A repo root "),t("code",[e._v("package.json")]),e._v(" script "),t("code",[e._v("release")]),e._v(" which runs "),t("code",[e._v("beachball publish")])]),e._v(" "),t("li",[e._v("The build is running on a Linux/Mac agent. (This could be easily adapted to a Windows agent with different syntax in the commands.)")])]),e._v(" "),t("div",{staticClass:"language-yml extra-class"},[t("pre",{pre:!0,attrs:{class:"language-yml"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Example trigger configurations (choose one or more, or another setup)")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("#")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release on push to main")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# trigger: [main]")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("#")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # Release on a schedule")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# # https://docs.microsoft.com/en-us/azure/devops/pipelines/build/triggers?tabs=yaml&view=azure-devops#supported-cron-syntax")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# schedules:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# - cron: '0 8 * * *'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# branches:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# include: [main]")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# This group should only be accessible to the release pipeline")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("variables")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("group")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Beachball secrets\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Variable syntax below assumes Linux/Mac but could be easily adapted to Windows")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("pool")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("vmImage")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" ubuntu"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v("latest\n\n"),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("steps")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# ... Other steps to set up repo and prepare for publishing (install, build, test, etc) ...")]),e._v("\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set the name, email, and URL with PAT")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("script")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("|")]),t("span",{pre:!0,attrs:{class:"token scalar string"}},[e._v('\n git config user.name "someone"\n git config user.email "someone@example.com"\n git remote set-url origin "https://$(REPO_PAT)@github.com/your-org/your-repo"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Set git credentials\n\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Pass the token on the command line for publishing")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("script")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" npm run release "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("-")]),e._v('token "$(NPM_TOKEN)"\n '),t("span",{pre:!0,attrs:{class:"token key atrule"}},[e._v("name")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(":")]),e._v(" Publish\n")])])]),t("h3",{attrs:{id:"azure-repos-azure-pipelines"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#azure-repos-azure-pipelines"}},[e._v("#")]),e._v(" Azure Repos + Azure Pipelines")]),e._v(" "),t("p",[e._v("This should be very similar to the GitHub version, aside from possibly the authentication method. You could potentially use personal access tokens for git and npm feed authentication (similar to above), or other methods are available which aren't currently covered here.")]),e._v(" "),t("p",[e._v("If you're publishing to a private Azure Artifacts npm feed, be sure to set "),t("code",[e._v("registry")]),e._v(" in the "),t("code",[e._v("beachball")]),e._v(" config "),t("a",{attrs:{href:"#setting-options-for-publishing"}},[e._v("as described above")]),e._v(".")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/32.5aced44f.js b/assets/js/32.88025b47.js similarity index 98% rename from assets/js/32.5aced44f.js rename to assets/js/32.88025b47.js index 3efde540..59e68e00 100644 --- a/assets/js/32.5aced44f.js +++ b/assets/js/32.88025b47.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{354: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],{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 diff --git a/assets/js/app.05993e09.js b/assets/js/app.dd72359f.js similarity index 96% rename from assets/js/app.05993e09.js rename to assets/js/app.dd72359f.js index 2b7bfa4c..cfe83acb 100644 --- a/assets/js/app.05993e09.js +++ b/assets/js/app.dd72359f.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 17991292..0f350762 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 98748886..da6a339b 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 58a63b94..af7ea69d 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 780767c5..6cf00289 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 083ad484..82e9df36 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 0e379454..0f1ee645 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 0b9b934c..e21bd5a8 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 b1e46b32..68d8b65c 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 38eaa64f..718a26da 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 4707ebec..e508f945 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 cfa841c0..418777f2 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 88528703..862dca3b 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 a7b980e1..f219a7e3 100644 --- a/overview/installation.html +++ b/overview/installation.html @@ -8,7 +8,7 @@ - + @@ -44,6 +44,6 @@ →

- +