version-policies.json 4.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. /**
  2. * This is configuration file is used for advanced publishing configurations with Rush.
  3. * More documentation is available on the Rush website: https://rushjs.io
  4. */
  5. /**
  6. * A list of version policy definitions. A "version policy" is a custom package versioning
  7. * strategy that affects "rush change", "rush version", and "rush publish". The strategy applies
  8. * to a set of projects that are specified using the "versionPolicyName" field in rush.json.
  9. */
  10. [
  11. // {
  12. // /**
  13. // * (Required) Indicates the kind of version policy being defined ("lockStepVersion" or "individualVersion").
  14. // *
  15. // * The "lockStepVersion" mode specifies that the projects will use "lock-step versioning". This
  16. // * strategy is appropriate for a set of packages that act as selectable components of a
  17. // * unified product. The entire set of packages are always published together, and always share
  18. // * the same NPM version number. When the packages depend on other packages in the set, the
  19. // * SemVer range is usually restricted to a single version.
  20. // */
  21. // "definitionName": "lockStepVersion",
  22. //
  23. // /**
  24. // * (Required) The name that will be used for the "versionPolicyName" field in rush.json.
  25. // * This name is also used command-line parameters such as "--version-policy"
  26. // * and "--to-version-policy".
  27. // */
  28. // "policyName": "MyBigFramework",
  29. //
  30. // /**
  31. // * (Required) The current version. All packages belonging to the set should have this version
  32. // * in the current branch. When bumping versions, Rush uses this to determine the next version.
  33. // * (The "version" field in package.json is NOT considered.)
  34. // */
  35. // "version": "1.0.0",
  36. //
  37. // /**
  38. // * (Required) The type of bump that will be performed when publishing the next release.
  39. // * When creating a release branch in Git, this field should be updated according to the
  40. // * type of release.
  41. // *
  42. // * Valid values are: "prerelease", "release", "minor", "patch", "major"
  43. // */
  44. // "nextBump": "prerelease",
  45. //
  46. // /**
  47. // * (Optional) If specified, all packages in the set share a common CHANGELOG.md file.
  48. // * This file is stored with the specified "main" project, which must be a member of the set.
  49. // *
  50. // * If this field is omitted, then a separate CHANGELOG.md file will be maintained for each
  51. // * package in the set.
  52. // */
  53. // "mainProject": "my-app"
  54. // },
  55. //
  56. // {
  57. // /**
  58. // * (Required) Indicates the kind of version policy being defined ("lockStepVersion" or "individualVersion").
  59. // *
  60. // * The "individualVersion" mode specifies that the projects will use "individual versioning".
  61. // * This is the typical NPM model where each package has an independent version number
  62. // * and CHANGELOG.md file. Although a single CI definition is responsible for publishing the
  63. // * packages, they otherwise don't have any special relationship. The version bumping will
  64. // * depend on how developers answer the "rush change" questions for each package that
  65. // * is changed.
  66. // */
  67. // "definitionName": "individualVersion",
  68. //
  69. // "policyName": "MyRandomLibraries",
  70. //
  71. // /**
  72. // * (Optional) This can be used to enforce that all packages in the set must share a common
  73. // * major version number, e.g. because they are from the same major release branch.
  74. // * It can also be used to discourage people from accidentally making "MAJOR" SemVer changes
  75. // * inappropriately. The minor/patch version parts will be bumped independently according
  76. // * to the types of changes made to each project, according to the "rush change" command.
  77. // */
  78. // "lockedMajor": 3,
  79. //
  80. // /**
  81. // * (Optional) When publishing is managed by Rush, by default the "rush change" command will
  82. // * request changes for any projects that are modified by a pull request. These change entries
  83. // * will produce a CHANGELOG.md file. If you author your CHANGELOG.md manually or announce updates
  84. // * in some other way, set "exemptFromRushChange" to true to tell "rush change" to ignore the projects
  85. // * belonging to this version policy.
  86. // */
  87. // "exemptFromRushChange": false
  88. // }
  89. {
  90. "definitionName": "lockStepVersion",
  91. "policyName": "adb",
  92. "version": "0.0.17",
  93. "nextBump": "patch"
  94. }
  95. ]