Skip to content

added new release version to release notes, replace task, removed emp…#486

Merged
Innavin369 merged 1 commit intomainfrom
fix-release-notes
Jan 23, 2025
Merged

added new release version to release notes, replace task, removed emp…#486
Innavin369 merged 1 commit intomainfrom
fix-release-notes

Conversation

@Innavin369
Copy link
Contributor

Added new 1.29.0 release version to the Release notes, replaced task OSDEV-1374 from 1.28 to 1.29 section, and removed empty sections from the previous 1.28 release.

@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:17 — with GitHub Actions Inactive
@sonarqubecloud
Copy link

@coderabbitai
Copy link

coderabbitai bot commented Jan 21, 2025

📝 Walkthrough

Walkthrough

The pull request updates the RELEASE-NOTES.md file for version 1.29.0 of the Open Supply Hub project. It introduces a new release section with comprehensive documentation covering database changes, code/API updates, architecture/environment modifications, bug fixes, and new features. The changes focus on a new search results page integration, database migration instructions, and a restructured release notes format, providing a detailed overview of the project's latest developments.

Changes

File Change Summary
doc/release/RELEASE-NOTES.md - Added new release section for version 1.29.0
- Introduced subsections: Introduction, Database changes, Code/API changes, Architecture/Environment changes, Bugfix, What's new
- Removed "Schema changes" subsection under version 1.28.0

Possibly related PRs

Suggested reviewers

  • vladsha-dev
  • roman-stolar
  • VadimKovalenkoSNF
  • mazursasha1990

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:19 — with GitHub Actions Inactive
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
doc/release/RELEASE-NOTES.md (3)

12-17: Remove placeholder text from sections.

The following sections contain placeholder text that should be replaced with actual changes:

  • Database changes
  • Code/API changes
  • Architecture/Environment changes
  • Bugfix
-* *Describe high-level database changes.*
+* No database changes in this release.

-* *Describe migrations here.*
+* No migrations in this release.

-* *Describe schema changes here.*
+* No schema changes in this release.

-* *Describe code/API changes here.*
+* No code/API changes in this release.

-* *Describe architecture/environment changes here.*
+* No architecture/environment changes in this release.

-* *Describe bugfix here.*
+* No bugfixes in this release.

Also applies to: 21-23, 24-26, 27-29

🧰 Tools
🪛 Markdownlint (0.37.0)

15-15: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


36-40: Add more context to the release instructions.

While the commands are clear, it would be helpful to:

  1. Explain why these commands are necessary
  2. Specify the order of execution
  3. Add any prerequisites or post-verification steps
 ### Release instructions:
 * Ensure that the following commands are included in the `post_deployment` command:
+    * Run in the following order:
     * `migrate`
+        * Applies any pending database migrations
     * `reindex_database`
+        * Rebuilds the search index to include new changes
+    * After running the commands:
+        * Verify the search functionality is working correctly
+        * Check that the new search results page is accessible
🧰 Tools
🪛 Markdownlint (0.37.0)

38-38: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


39-39: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


36-36: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


Line range hint 1-40: Fix markdown formatting issues.

There are several markdown formatting inconsistencies:

  1. Unordered list indentation should be 2 spaces instead of 4
  2. Use consistent list markers (asterisks instead of dashes)
  3. Remove trailing colons from headings
-### Database changes:
+### Database changes

-### Release instructions:
+### Release instructions

-    * `migrate`
+  * `migrate`

-    * `reindex_database`
+  * `reindex_database`
🧰 Tools
🪛 Markdownlint (0.37.0)

32-32: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


33-33: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


34-34: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


32-32: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


33-33: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


34-34: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


38-38: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


39-39: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


44-44: null
Multiple headings with the same content

(MD024, no-duplicate-heading)


15-15: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


36-36: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 99be6b4 and eb9f8f9.

📒 Files selected for processing (1)
  • doc/release/RELEASE-NOTES.md (2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
doc/release/RELEASE-NOTES.md

32-32: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


33-33: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


34-34: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


32-32: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


33-33: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


34-34: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


38-38: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


39-39: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


15-15: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)


36-36: Punctuation: ':'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: run-integration-test-code-quality
  • GitHub Check: run-flake8-linter
  • GitHub Check: run-fe-code-quality
  • GitHub Check: run-eslint-linter-and-prettier-formatter
  • GitHub Check: run-django-code-quality
  • GitHub Check: run-dd-code-quality
  • GitHub Check: run-countries-code-quality
  • GitHub Check: run-contricleaner-code-quality
  • GitHub Check: get-base-branch-fe-cov
  • GitHub Check: get-base-branch-contricleaner-cov
  • GitHub Check: get-base-branch-django-cov
  • GitHub Check: get-base-branch-countries-cov
  • GitHub Check: get-base-branch-dd-cov
🔇 Additional comments (1)
doc/release/RELEASE-NOTES.md (1)

30-34: LGTM! Clear description of the new search results page implementation.

The section provides good details about:

  • The integration with GET v1/production-locations
  • The routing configuration between search-related pages
  • The maximum result limit setting
🧰 Tools
🪛 Markdownlint (0.37.0)

32-32: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


33-33: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


34-34: Expected: asterisk; Actual: dash
Unordered list style

(MD004, ul-style)


32-32: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


33-33: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)


34-34: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

@barecheck
Copy link

barecheck bot commented Jan 21, 2025

React App | Jest test suite - Code coverage report

Total: 28.37%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

Copy link
Contributor

@mazursasha1990 mazursasha1990 left a comment

Choose a reason for hiding this comment

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

LGTM

@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:23 — with GitHub Actions Inactive
@barecheck
Copy link

barecheck bot commented Jan 21, 2025

Dedupe Hub App | Unittest test suite - Code coverage report

Total: 56.14%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:24 — with GitHub Actions Inactive
@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:24 — with GitHub Actions Inactive
@barecheck
Copy link

barecheck bot commented Jan 21, 2025

Contricleaner App | Unittest test suite - Code coverage report

Total: 98.91%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@barecheck
Copy link

barecheck bot commented Jan 21, 2025

Countries App | Unittest test suite - Code coverage report

Total: 100%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

@Innavin369 Innavin369 temporarily deployed to Quality Environment January 21, 2025 14:34 — with GitHub Actions Inactive
@barecheck
Copy link

barecheck bot commented Jan 21, 2025

Django App | Unittest test suite - Code coverage report

Total: 80.16%

Your code coverage diff: 0.00% ▴

✅ All code changes are covered

Copy link
Contributor

@vladsha-dev vladsha-dev left a comment

Choose a reason for hiding this comment

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

LGTM

@Innavin369 Innavin369 merged commit bbd9037 into main Jan 23, 2025
21 checks passed
@Innavin369 Innavin369 deleted the fix-release-notes branch January 23, 2025 11:22
protsack-stephan pushed a commit that referenced this pull request Apr 12, 2025
#486)

Added new 1.29.0 release version to the Release notes, replaced task
OSDEV-1374 from 1.28 to 1.29 section, and removed empty sections from
the previous 1.28 release.

Co-authored-by: Inessa Druzhkova <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants