Refactor the SDK files to enable a monolithic repository #317
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
After moving the SDK from the root of the repository (`.`) to `./sdk`, we adapt the `sdk/pyproject.toml` with the necessary changes. Namely, `setuptools-scm` needs to know where the repository root is. While we're at it, we change the `write_to` option which is deprecated to the new `version_file` option. We also adapt the `.gitignore` by ignoring the prior ignored files now in all directories, not just the repository root.
This adapts the existing `sdk/README.md` to suit the new repository structure. Furthermore, we add a new repository level `./README.md`.
This adapts the `.github/workflows/ci.yml` to the new repository structure. Namely, we prefix all jobs with `sdk-` to differentiate them from jobs concerning other future packages and adapt the paths of them to reflect the moving of the SDK code from `.` to `./sdk`.
Contributor
|
LGTM, I see no problems 👍 |
s-heppner
added a commit
to rwth-iat/basyx-python-sdk-http-server-docker
that referenced
this pull request
Nov 4, 2024
Previously, the Eclipse BaSyx-Python SDK contained just the SDK module. With the recent refactoring of the SDK GitHub repository towards a monolithic structure, the SDK module moved into the `./sdk` subdirectory, see [basyx-python-sdk#317]. With the new repository structure, we obviously have to adapt the install path of the SDK in this Dockerfile, which has been done here. [basyx-python-sdk#317]: eclipse-basyx/basyx-python-sdk#317
Frosty2500
pushed a commit
to rwth-iat/basyx-python-sdk
that referenced
this pull request
Nov 11, 2024
Previously, the Eclipse BaSyx-Python SDK contained just the SDK module. With the recent refactoring of the SDK GitHub repository towards a monolithic structure, the SDK module moved into the `./sdk` subdirectory, see [basyx-python-sdk#317]. With the new repository structure, we obviously have to adapt the install path of the SDK in this Dockerfile, which has been done here. [basyx-python-sdk#317]: eclipse-basyx#317
s-heppner
added a commit
that referenced
this pull request
Nov 17, 2024
Previously, the Eclipse BaSyx-Python SDK contained just the SDK module. With the recent refactoring of the SDK GitHub repository towards a monolithic structure, the SDK module moved into the `./sdk` subdirectory, see [basyx-python-sdk#317]. With the new repository structure, we obviously have to adapt the install path of the SDK in this Dockerfile, which has been done here. [basyx-python-sdk#317]: #317
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We decided to follow a monolithic approach with our Eclipse BaSyx Python project, where multiple packages are contained in the same GitHub repository, in order to enforce compatibility between them at every PR using our CI tools. This PR prepares the repository by moving all the SDK code from
.to./sdkand adapting the paths at the necessary spots.The new repository structure is going to be as follows:
In order to adapt the repository, I had to do the following steps:
d12f637 Move SDK code from . to ./sdk
2ec791e Update sdk/pyproject.toml and .gitignore to new repository structure
After moving the SDK from the root of the repository (
.) to./sdk, we adapt thesdk/pyproject.tomlwith the necessary changes.Namely,
setuptools-scmneeds to know where the repository root is. While we're at it, we change thewrite_tooption which is deprecated to the newversion_fileoption. See the scm documentation here.We also adapt the
.gitignoreby ignoring the prior ignored files now in all directories, not just the repository root.093bde1 Adapt sdk/README.md, add repository level README.md
This adapts the existing
sdk/README.mdto suit the new repository structure. Furthermore, we add a new repository level./README.md.dde25b9 .github/workflows: Adapt paths in ci.yml
This adapts the
.github/workflows/ci.ymlto the new repository structure. Namely, we prefix all jobs withsdk-to differentiate them from jobs concerning other future packages and adapt the paths of them to reflect the moving of the SDK code from.to./sdk.