@sproutsocial/racine 7.4.0-beta-momo.1 → 7.4.0-beta-unc-momo.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +17 -11
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Change Log
2
2
 
3
+ ## 7.3.5
4
+
5
+ ### Patch Changes
6
+
7
+ - a929081: Fix quoting of package version in deprecate command in beta release action.
8
+
3
9
  ## 7.3.4
4
10
 
5
11
  ### Patch Changes
package/README.md CHANGED
@@ -160,27 +160,33 @@ When making changes to Racine it often not possible to be certain that your chan
160
160
 
161
161
  #### **Releasing a beta**
162
162
 
163
- To release a beta version, commit your current changes and then run `yarn beta:release`. This command will create a new beta version with a semantic bump level based on your changeset(s), and include a differentiating identifier from your git user email name. For example, if [Bill Foehring](bfoehring@sproutsocial.com) was making a minor change to versions `6.55.3`, the command would:
164
- 1. create version `6.56.0-beta-bfoehring.0`,
163
+ To release a beta version, commit your current changes and then run `yarn beta:release`. This command will create a new beta version with a semantic bump level based on your changeset(s), and will prompt you to include a differentiating suffix. Alternatively, you can specify the suffix as a param to the command. For example, if making a minor change to versions `6.55.3`, executing `yarn beta:release uncle-momo` would:
164
+ 1. create version `6.56.0-beta-uncle-momo.0`,
165
165
  1. add a corresponding tag in git,
166
- 1. and publish the new beta version to the npm registry.
166
+ 1. push the tag and version commit to Github,
167
+ 1. run the *beta-release* Github action,
168
+ 1. publish your new beta version to the npm registry.
167
169
 
168
- Once a beta release is published you can include it as a dependency from `web-app-core` or `seeds`.
170
+ Once the action completes, your beta will be available in the *Current (distribution) Tags* on [NPM](https://www.npmjs.com/package/@sproutsocial/racine?activeTab=versions). Note: your published beta is marked as *deprecated* to prevent it from showing in the package's *Version History*
169
171
 
170
- The differentiating identifier is necessary to enable if two or more developers to concurrently create their own beta versions from the current version of Racine. Without the identifiers, the name of the beta versions could collide.
172
+ Once you beta release is published, you can include it as a dependency from `web-app-core` or `seeds`.
173
+
174
+ The differentiating suffix is necessary to enable if two or more developers to concurrently create their own beta versions from the current version of Racine. Without the suffixes, the names of the beta versions could collide.
175
+
176
+ ##### **Modify your beta**
177
+
178
+ As you continue to make changes, rerunning `yarn beta:release` will release a new version of your beta. From the example above, it would create `6.56.0-beta-uncle-momo.1` as the next beta release. Running it again would create `6.56.0-beta-uncle-momo.2` and so on...
171
179
 
172
180
  #### **Checking beta status**
173
181
 
174
182
  Run `yarn beta:status` to see the info Racine has about your current beta version.
175
183
 
176
- As you continue to make changes, rerunning `yarn beta:release` will release a new version of your beta. From the example above, it would create `6.56.0-beta-bfoehring.1` as the next beta release. Running it again would create `6.56.0-beta-bfoehring.2` and so on...
177
-
178
- #### **Deprecating a beta**
184
+ #### **Completing a beta**
179
185
 
180
- When you are satisfied that all of your changes are correct, you can end your beta by running `yarn beta:deprecate`. This will:
181
- - delete any beta metadata,
186
+ When you are satisfied that all of your changes are correct, you can end your beta by running `yarn beta:complete`. This will:
187
+ - remove any local and remote git tags for your beta,
182
188
  - restore the original version within `package.json`,
183
- - deprecate any beta releases on the registry for this version.
189
+ - delete any beta metadata.
184
190
 
185
191
  Doing so will prime the changeset mechanism to complete the standard release process. (Note: The version of the final release is set at the last moment to ensure it actually is properly set the next valid semantic version as other versions of Racine may have been released during the time you are working on yours.)
186
192
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sproutsocial/racine",
3
- "version": "7.4.0-beta-momo.1",
3
+ "version": "7.4.0-beta-unc-momo.0",
4
4
  "license": "MIT",
5
5
  "files": [
6
6
  "__flow__",