[Bug 576137] Migrating BaSyx to GitHub

Bugzilla Link	576137
Status	REOPENED
Importance	P3 normal
Reported	Sep 21, 2021 04:15 EDT
Modified	Dec 10, 2021 16:30 EDT

Description

Dear all,

we would like to migrate the BaSyx repository (https://git.eclipse.org/r/basyx/basyx) to GitHub. In this migration process, we plan to split the single repository that currently exists into multiple repositories. Additionally, we plan to keep the existing repository as archive and start with a fresh history to reduce repository size.

Our future repository structure should be as follows:
• eclipse-basyx/java-sdk
• eclipse-basyx/java-components
• eclipse-basyx/java-examples
• eclipse-basyx/cpp-sdk
• eclipse-basyx/cpp-components
• eclipse-basyx/dotnet-sdk
• eclipse-basyx/dotnet-components
• eclipse-basyx/dotnet-applications
• eclipse-basyx/dotnet-examples
• eclipse-basyx/applications

To my knowledge, there are two possibilities: joining the existing EclipseFdn organization or creating a new one (eclipse-basyx). Are there any notable differences between both approachs?

Best regards,
Frank

added Bugzilla legacy ~16280 labels

Is there any update on this?

Sorry this clearly got lost somewhere.

The only real difference between being part of the Eclipse organization and a new one is the URL for the repositories.

For the transition, are you expecting us(Webmaster) to create all of the repos, and then the project can move at their own pace?

-M.

Yes, the idea would be that each project can move at their own pace. Thus, each of these repositories would be empty at the start.

Ok I've created the following repos:

https://github.com/eclipse-basyx/java-sdk
https://github.com/eclipse-basyx/java-components
https://github.com/eclipse-basyx/java-examples
https://github.com/eclipse-basyx/cpp-sdk
https://github.com/eclipse-basyx/cpp-components
https://github.com/eclipse-basyx/dotnet-sdk
https://github.com/eclipse-basyx/dotnet-components
https://github.com/eclipse-basyx/dotnet-applications
https://github.com/eclipse-basyx/dotnet-examples
https://github.com/eclipse-basyx/applications

Basyx committers that have added their Github IDs to their Eclipse.org account should receive access the next time our sync tool runs.

-M.

By Thomas Psota

Hello,

Basyx committers that have added their Github IDs to their Eclipse.org account should receive access the next time our sync tool runs.

are we really talking about the Github ID here or just the username?
The ID has to be queried and retrieved using the Github API e.g. https://api.github.com/users/eclipse

And where can I find this field on my eclipse.org account profile page?
There is a social media link for Github where I can insert my Github Username.
Is this the right field?

Best regards,
Thomas

(In reply to Thomas Psota from comment #5)

are we really talking about the Github ID here or just the username?

We are talking about your GitHub user name.

And where can I find this field on my eclipse.org account profile page?
There is a social media link for Github where I can insert my Github
Username.
Is this the right field?

Yes

By Thomas Psota

(In reply to Frederic Gurr from comment #6)

(In reply to Thomas Psota from comment #5)\

are we really talking about the Github ID here or just the username?
We are talking about your GitHub user name.

And where can I find this field on my eclipse.org account profile page?
There is a social media link for Github where I can insert my Github
Username.
Is this the right field?
Yes

Okay, thank you! :-)

There will be a Rust SDK soon. Would it be possible to also create a rust-sdk repository?

Additionally, I realized that the search on GitHub only searchs for repository names, not organizations.
Thus, wouldn't it be more sensible to include "basyx" as prefix in all repository names (e.g. basyx_java_sdk)?

(In reply to Frank Schnicke from comment #8)

There will be a Rust SDK soon. Would it be possible to also create a
rust-sdk repository?

https://github.com/eclipse-basyx/rust-sdk has been created. Committers will gain access once the sync script runs (~2h).

Additionally, I realized that the search on GitHub only searchs for
repository names, not organizations.
Thus, wouldn't it be more sensible to include "basyx" as prefix in all
repository names (e.g. basyx_java_sdk)?

There is an easy fix for this. Adding the "topic" (GitHub's name for tags) "basyx" to the repos immediately leads to them being found when searching for it. I did this for all repos as a quick workaround.

Adding the basyx prefix in the repository name still makes sense IMHO, since the repository name loses a lot of context without the organization name. For example, if someone does a git clone, a folder called "java-sdk" does not make it clear which project it belongs to.

(In reply to Frederic Gurr from comment #9)

I did this for all repos as a quick workaround.

Correction: all repos that are not empty.

Adding the basyx prefix in the repository name still makes sense IMHO, since
the repository name loses a lot of context without the organization name.
For example, if someone does a git clone, a folder called "java-sdk" does
not make it clear which project it belongs to.

Many thanks for adding the tags.
Can you update the repository names to be prefixed with basyx, i.e. basyx-java-sdk etc.?

All basyx repos have been renamed. You will need to adjust your local Git configuration and CI build jobs accordingly.

Many thanks.

We're in conversations right now to also publish a python SDK. Would it be possible to create a basyx-python-sdk repository for this?

Sure. Let us know when you are ready and we can create it.

(In reply to Frederic Gurr from comment #14)

Sure. Let us know when you are ready and we can create it.

We're ready. Please create the basyx-sdk-python repository.

Additionally, we would like to publish the content of basyx-rust-sdk to crates.io.
Would it be possible that you configure the relevant secrets in the repository so that we can publish to crates.io via GitHub workflows?

(In reply to Frank Schnicke from comment #15)

We're ready. Please create the basyx-sdk-python repository.

To be in line with the naming of the other sdk repositories I'd suggest to slightly change the name to basyx-python-sdk.

(In reply to Frederic Gurr from comment #16)

(In reply to Frank Schnicke from comment #15)\

We're ready. Please create the basyx-sdk-python repository.
To be in line with the naming of the other sdk repositories I'd suggest to
slightly change the name to basyx-python-sdk.

You're 100% right, thanks for double-checking :)

(In reply to Frank Schnicke from comment #15)

Additionally, we would like to publish the content of basyx-rust-sdk to
crates.io.
Would it be possible that you configure the relevant secrets in the
repository so that we can publish to crates.io via GitHub workflows?

I've created a crates.io access token and added it to the GitHub organization secret called "CRATES_IO_TOKEN".

(In reply to Frank Schnicke from comment #17)

You're 100% right, thanks for double-checking :)

np. https://github.com/eclipse-basyx/basyx-python-sdk has been created. Committers will gain access once the sync script runs (~2h).