Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update release documentation #7519

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: update release documentation #7519

wants to merge 2 commits into from

Conversation

unlikelyzero
Copy link
Collaborator

@unlikelyzero unlikelyzero commented Feb 22, 2024

Closes #7534

Describe your changes:

Quick pass on updating our release note documentation

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Is this a notable change that will require a special callout in the release notes Notable Change ? For example, will this break compatibility with existing APIs or projects which source these plugins?

Author Checklist

  • Changes address original issue?
  • Tests included and/or updated with changes?
  • Has this been smoke tested?
  • Have you associated this PR with a type: label? Note: this is not necessarily the same as the original issue.
  • Have you associated a milestone with this PR? Note: leave blank if unsure.
  • Is this a breaking change to be called out in the release notes?
  • Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

  • Changes appear to address issue?
  • Reviewer has tested changes by following the provided instructions?
  • Changes appear not to be breaking changes?
  • Appropriate automated tests included?
  • Code style and in-line documentation are appropriate?

Copy link

codecov bot commented Feb 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.13%. Comparing base (dc9bd8b) to head (45cbf51).
Report is 115 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #7519      +/-   ##
==========================================
- Coverage   55.48%   55.13%   -0.35%     
==========================================
  Files         672      672              
  Lines       26961    26961              
  Branches     2620     2620              
==========================================
- Hits        14958    14864      -94     
- Misses      11286    11378      +92     
- Partials      717      719       +2     
Flag Coverage Δ
e2e-full 21.69% <ø> (-19.86%) ⬇️
e2e-stable 59.30% <ø> (+0.01%) ⬆️
unit 48.43% <ø> (-0.10%) ⬇️

see 14 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc9bd8b...45cbf51. Read the comment docs.

Versioning is a critical step for package release. The Open MCT team follows [Semantic Versioning (SemVer)](https://semver.org) that consists of three major components: MAJOR.MINOR.PATCH. These ensure a structured process for updating, bug fixes, backward compatibility, and software progress.
Versioning is a critical step for package release. Open MCT follows [Semantic Versioning 2.0.0 (SemVer)](https://semver.org) that consists of three major components: MAJOR.MINOR.PATCH. These ensure a structured process for updating, bug fixes, backward compatibility, and software progress.

Major releases are necessitated by fundamental framework changes that are expected to be incompatible
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Angular -> Vue2+TimeAPI Deprecation warning -> Vue3+ES6 Shim -> Vue3 + ESM

Major releases are necessitated by fundamental framework changes that are expected to be incompatible
with previous releases.

Minor releases are necessitated by non-backwards-compatible application, API changes, or new
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the standard.

- **API Change**
- Signifies when a contribution makes any complete or under layer changes to the communication or its supporting access processes. This label flags required see-through insight on how the web-based control panel sees and manipulates any value and or network logs.
- **Default Behavior Change**
- In the incident an update either adjusts a form to or integrates a not previously kept setting or plugin. i.e. autoscale is enabled by default when working with plots.

## 6. Community & Contributions

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add section on deprecation.

Summary Widget Deprecated Example.

  • Notify Users
  • Supposed to write interceptor to convert to conditionWidgets
  • Deprecation warning

## 1. Pre-requisites

Before releasing a new version of the NASA Open MCT NPM package, ensure all dependencies are updated, and comprehensive tests are performed. This ensures compatibility and performance of the Open MCT within the Node.js ecosystem.
Before releasing a new version of Open MCT, ensure that all dependencies are updated, and
comprehensive testing is performed.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define "core" plugin and "peripheral" plugin

@unlikelyzero unlikelyzero marked this pull request as ready for review February 28, 2024 22:52
@unlikelyzero unlikelyzero added the type:maintenance tests, chores, or project maintenance label Feb 28, 2024
@unlikelyzero unlikelyzero added this to the Target:4.0.0 milestone Feb 28, 2024
@ozyx ozyx changed the title docs(WIP): update release documentation docs: update release documentation Mar 5, 2024
- [NPM](https://www.npmjs.com/package/openmct)
- [Github Releases](https://github.com/nasa/openmct/releases)
2. What do we publish?
- What constitutes a "stable" release?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the different release types be clustered under another header, like
What kinds of releases do we publish?

  • Stable: blah blah
  • Latest: The most recently published release.
  • Nightly: yada yada

- **Breaking Change**
- Highlights the integration of changes that are suspected to break, or without a doubt will
break, backwards compatibility. These should signal to users the upgrade might be seamless only
if dependency and integration factors are properly managed, if not, one should expect to manage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...properly managed, and if not, one should...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:maintenance tests, chores, or project maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Release] Update release documentation to better describe open mct releases
3 participants