Skip to content

Conversation

@deepin-ci-robot
Copy link
Contributor

@deepin-ci-robot deepin-ci-robot commented Jun 9, 2025

Synchronize source files from linuxdeepin/dtkdeclarative.

Source-pull-request: linuxdeepin/dtkdeclarative#490

Summary by Sourcery

Sync build configuration with upstream by externalizing project version and adding sync support files

Enhancements:

  • Source DTK version from external VERSION file instead of hardcoding in CMakeLists.txt

Chores:

  • Add VERSION.in template for upstream version synchronization
  • Introduce .syncexclude to manage files excluded from upstream sync

@deepin-ci-robot
Copy link
Contributor Author

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: deepin-ci-robot

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@sourcery-ai
Copy link

sourcery-ai bot commented Jun 9, 2025

Reviewer's Guide

Synchronize DTK Declarative with the linuxdeepin upstream by externalizing version handling via a new VERSION file and adding synchronization support files.

Sequence Diagram: CMake Reading Project Version

sequenceDiagram
    participant CMakeProcess as "CMake Process (CMakeLists.txt)"
    participant FileSystem
    participant VersionFile as "VERSION File"

    CMakeProcess->>FileSystem: file(READ "VERSION")
    FileSystem-->>CMakeProcess: Raw content (e.g., "5.6.24\n")
    CMakeProcess->>CMakeProcess: string(STRIP content)
    Note right of CMakeProcess: DTK_FILE_VERSION = "5.6.24"
    CMakeProcess->>CMakeProcess: set(DTK_VERSION, DTK_FILE_VERSION)
    Note right of CMakeProcess: Project version set to "5.6.24"
Loading

File-Level Changes

Change Details Files
Externalize version management to an external VERSION file
  • Read version string from VERSION in CMakeLists.txt
  • Strip whitespace from the read content
  • Set DTK_VERSION cache variable from the file value
CMakeLists.txt
Introduce synchronization config and version template
  • Add .syncexclude to define files excluded from upstream sync
  • Add VERSION.in as a template for initializing the VERSION file
.syncexclude
VERSION.in

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @deepin-ci-robot - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +3 to +5
file(READ "${CMAKE_CURRENT_SOURCE_DIR}/VERSION" DTK_FILE_VERSION)
string(STRIP "${DTK_FILE_VERSION}" DTK_FILE_VERSION)
set(DTK_VERSION "${DTK_FILE_VERSION}" CACHE STRING "Define project version")
Copy link

Choose a reason for hiding this comment

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

suggestion: Consider behavior if VERSION file is missing or empty.

If the 'VERSION' file is missing or empty, DTK_VERSION will also be empty. Should we add a check to handle this case, such as providing a default value or raising an error?

Suggested change
file(READ "${CMAKE_CURRENT_SOURCE_DIR}/VERSION" DTK_FILE_VERSION)
string(STRIP "${DTK_FILE_VERSION}" DTK_FILE_VERSION)
set(DTK_VERSION "${DTK_FILE_VERSION}" CACHE STRING "Define project version")
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/VERSION")
file(READ "${CMAKE_CURRENT_SOURCE_DIR}/VERSION" DTK_FILE_VERSION)
string(STRIP "${DTK_FILE_VERSION}" DTK_FILE_VERSION)
if(DTK_FILE_VERSION STREQUAL "")
message(FATAL_ERROR "VERSION file is empty. Please provide a valid version.")
endif()
set(DTK_VERSION "${DTK_FILE_VERSION}" CACHE STRING "Define project version")
else()
message(FATAL_ERROR "VERSION file not found. Please create a VERSION file with the project version.")
endif()

Synchronize source files from linuxdeepin/dtkdeclarative.

Source-pull-request: linuxdeepin/dtkdeclarative#490
@deepin-ci-robot
Copy link
Contributor Author

deepin pr auto review

关键摘要:

  • .reuse/dep5文件中新增了.syncexclude文件,需要确认是否有必要排除linglong.yamlVERSION文件。
  • CMakeLists.txt文件中,通过读取VERSION文件来设置DTK_VERSION,这是一个好的做法,因为它允许版本信息从外部文件中读取。
  • 新增的.syncexclude文件和VERSION.in模板文件可能需要进一步的文档说明,以便其他开发者理解其用途。

是否建议立即修改:

  • 是,特别是如果新增的文件和配置没有充分的文档说明,这可能会导致其他开发者在维护项目时产生困惑。

@deepin-bot
Copy link
Contributor

deepin-bot bot commented Jun 19, 2025

TAG Bot

New tag: 6.0.37
DISTRIBUTION: unstable
Suggest: synchronizing this PR through rebase #267

@deepin-bot
Copy link
Contributor

deepin-bot bot commented Jun 27, 2025

TAG Bot

New tag: 6.0.38
DISTRIBUTION: unstable
Suggest: synchronizing this PR through rebase #270

@deepin-bot
Copy link
Contributor

deepin-bot bot commented Jul 3, 2025

TAG Bot

New tag: 6.0.39
DISTRIBUTION: unstable
Suggest: synchronizing this PR through rebase #274

@18202781743 18202781743 closed this Jul 8, 2025
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