ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-13 20:58:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update the versioning process to include publishing to npmjs registry (#3354)

Browse Source
This commit is contained in:
Shefali Joshi
2020-09-14 12:23:16 -07:00
committed by GitHub
parent b4c44c6d49
commit e52f60fdf0
1 changed files with 32 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/src/process/version.md
View File

@ -92,47 +92,59 @@ should update (or delegate the task of updating) Open MCT version
numbers by the following process: numbers by the following process:
1. Update version number in `package.json` 1. Update version number in `package.json`
1. Remove `-SNAPSHOT` suffix. 1. Create a new branch off the `master` branch.
2. Verify that resulting version number meets semantic versioning 2. Remove `-SNAPSHOT` suffix from the version in `package.json`.
requirements relative to previous stable version. Increment if 3. Verify that resulting version number meets semantic versioning
necessary. requirements relative to previous stable version. Increment the
3. If version is considered unstable (which may be the case during version number if necessary.
4. If version is considered unstable (which may be the case during
the first three sprints of a release), apply a new suffix per the first three sprints of a release), apply a new suffix per
[Version Numbering](#version-numbering) guidance above. [Version Numbering](#version-numbering) guidance above.
2. Tag the release. 2. Tag the release.
1. Commit changes to `package.json` on the `master` branch. 1. Commit changes to `package.json` on the new branch created in
the previous step.
The commit message should reference the sprint being closed, The commit message should reference the sprint being closed,
preferably by a URL reference to the associated Milestone in preferably by a URL reference to the associated Milestone in
GitHub. GitHub.
2. Verify that build still completes, that application passes 2. Verify that build still completes, that application passes
smoke-testing, and that only differences from tested versions smoke-testing, and that only differences from tested versions
are the changes to version number above. are the changes to version number above.
3. Push the `master` branch. 3. Push the new branch.
4. Tag this commit with the version number, prepending the letter "v". 4. Tag this commit with the version number, prepending the letter "v".
(e.g. `git tag v0.9.3-alpha`) (e.g. `git tag v0.9.3-alpha`)
5. Push the tag to GitHub. (e.g. `git push origin v0.9.3-alpha`). 5. Push the tag to GitHub. (e.g. `git push origin v0.9.3-alpha`).
3. Upload a release archive. 3. Upload a release archive.
1. Run `npm pack` to generate the archive. 1. Use the [GitHub release interface](https://github.com/nasa/openmct/releases)
2. Use the [GitHub release interface](https://github.com/nasa/openmct/releases)
to draft a new release. to draft a new release.
3. Choose the existing tag for the new version (created and pushed above.) 2. Choose the existing tag for the new version (created and pushed above.)
Enter the tag name as the release name as well; see existing releases Enter the tag name as the release name as well; see existing releases
for examples. for examples. (e.g. `Open MCT v0.9.3-alpha`)
4. Attach the release archive. 3. Designate the release as a "pre-release" as appropriate (for instance,
5. Designate the release as a "pre-release" as appropriate (for instance,
when the version number has been suffixed as unstable, or when when the version number has been suffixed as unstable, or when
the version number is below 1.0.0.) the version number is below 1.0.0.)
4. Restore snapshot status in `package.json` 4. Add release notes including any breaking changes, enhancements,
1. Remove any suffix from the version number, or increment the bug fixes with solutions in brief.
_patch_ version if there is no suffix. 5. Publish the release.
2. Append a `-SNAPSHOT` suffix. 4. Publish the release to npm
3. Commit changes to `package.json` on the `master` branch. 1. Login to npm
2. Checkout the tag created in the previous step.
3. In `package.json` change package to be public (private: false)
4. Test the package before publishing by doing `npm publish --dry-run`
if necessary.
5. Publish the package to the npmjs registry (e.g. `npm publish --access public`)
6. Confirm the package has been published (e.g. `https://www.npmjs.com/package/openmct`)
5. Update snapshot status in `package.json`
1. Create a new branch off the `master` branch.
2. Remove any suffix from the version number,
or increment the _patch_ version if there is no suffix.
3. Append a `-SNAPSHOT` suffix.
4. Commit changes to `package.json` on the `master` branch.
The commit message should reference the sprint being opened, The commit message should reference the sprint being opened,
preferably by a URL reference to the associated Milestone in preferably by a URL reference to the associated Milestone in
GitHub. GitHub.
4. Verify that build still completes, that application passes 5. Verify that build still completes, that application passes
smoke-testing. smoke-testing.
5. Push the `master` branch. 6. Create a PR to be merged into the `master` branch.
Projects dependent on Open MCT being co-developed by the Open MCT Projects dependent on Open MCT being co-developed by the Open MCT
team should follow a similar process, except that they should team should follow a similar process, except that they should