Add DR about module folder structure - #3194
aschemmel-tech wants to merge 2 commits into
Conversation
masc2023
left a comment
There was a problem hiding this comment.
Get feedback from Communities, Feature Teams
|
Discussed with FT's: |
MaciejKaszynski
left a comment
There was a problem hiding this comment.
Fine with lifecycle
AlexanderLanin
left a comment
There was a problem hiding this comment.
fine for infrastructure work either way; some sort of alignment is always preferred for us
| Context | ||
| ------- | ||
|
|
||
| The S-CORE project defines as part of the project's processes a `module folder structure <https://eclipse-score.github.io/score/main/contribute/general/folder.html#module-folder-structure>`_. |
There was a problem hiding this comment.
Add link and one sentence from central folder definition in S-CORE to this DR ?
c80bc05
c80bc05
|
Documentation preview for this pull request is available at: |
Removes the top-level /src and /tests folders and the cpp/rust language split, per eclipse-score/score#3194 (module folder structure DR): the src folder is optional and dropped, public interfaces live directly in score/<component>/, and internal/rust_kvs/rust_kvs_tool become lower_level_comp folders. Integration test suites move to score/kvs/tests/ since this module has a single component. Updates all Bazel targets, CI workflows, Cargo/pytest config, and docs that referenced the old paths, including the coverage targets newly introduced by #380.
|
fine for persistency ... realization in eclipse-score/persistency#386 |
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| DR-002-Proc: Module Folder Structure |
There was a problem hiding this comment.
| DR-002-Proc: Module Folder Structure | |
| DR-003-Proc: Module Folder Structure |
Removes the top-level /src and /tests folders and the cpp/rust language split, per eclipse-score/score#3194 (module folder structure DR): the src folder is optional and dropped, public interfaces live directly in score/<component>/, and internal/rust_kvs/rust_kvs_tool become lower_level_comp folders. Integration test suites move to score/kvs/tests/ since this module has a single component. Updates all Bazel targets, CI workflows, Cargo/pytest config, and docs that referenced the old paths, including the coverage targets newly introduced by #380.
…cture (#386) * restructure: align module folder layout with score DR Removes the top-level /src and /tests folders and the cpp/rust language split, per eclipse-score/score#3194 (module folder structure DR): the src folder is optional and dropped, public interfaces live directly in score/<component>/, and internal/rust_kvs/rust_kvs_tool become lower_level_comp folders. Integration test suites move to score/kvs/tests/ since this module has a single component. Updates all Bazel targets, CI workflows, Cargo/pytest config, and docs that referenced the old paths, including the coverage targets newly introduced by #380. * ci: run same-repo PR workflows via pull_request, not stale main pull_request_target always evaluates the workflow YAML from the base branch (main) while checking out the PR's source tree. Since this PR's branch lives in eclipse-score/persistency itself (not a fork), the build/docs/license-check checks kept running main's stale workflow copy against the restructured tree and failed on removed paths. Add a same-repo pull_request trigger alongside pull_request_target, gated so same-repo PRs run untrusted-secret-free via pull_request and fork PRs still require approval via pull_request_target. * docs: align module documentation and generated paths Keep module-level documentation under docs/module as required by the SCORE module folder structure, and keep KVS component documentation and diagrams under score/kvs/docs. Document the intentional single-component layout: component tests remain under score/kvs/tests, while the optional component src directory is omitted so public interfaces and implementation files stay directly in score/kvs. Update the moved documentation toctree, test README paths, and QNX image references.
DR raised based on the discussion here:
https://github.com/orgs/eclipse-score/discussions/434#discussioncomment-18048797