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

Add upgrade notes #1490

Merged
merged 1 commit into from
Sep 9, 2024
Merged

Add upgrade notes #1490

merged 1 commit into from
Sep 9, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Sep 8, 2024

Description

Adds upgrade notes.

While we do label breaking changes in pull requests and issues, we can't expect users to sift through all of them to determine whether any action is needed upon upgrading to a newer version.

This adds a new Upgrading page to the documentation, which will list notable and breaking changes for each version.

Addressed Issue

N/A

Additional Details

N/A

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have updated the migration changelog accordingly
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

While we do label breaking changes in pull requests and issues, we can't expect users to sift through all of them to determine whether any action is needed upon upgrading to a newer version.

This adds a new Upgrading page to the documentation, which will list notable and breaking changes for each version.

Signed-off-by: nscuro <[email protected]>
@nscuro nscuro added the documentation Improvements or additions to documentation label Sep 8, 2024
@nscuro nscuro added this to the 0.6.0 milestone Sep 8, 2024
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+2.67% (target: -1.00%) (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (9e2ead4) 172 140 81.40%
Head commit (fc38987) 6864 (+6692) 5770 (+5630) 84.06% (+2.67%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#1490) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

@nscuro nscuro merged commit ce54d4f into main Sep 9, 2024
13 checks passed
@nscuro nscuro deleted the upgrade-notes branch September 9, 2024 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant