[Bug 576137] Migrating BaSyx to GitHub

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).

(In reply to Frederic Gurr from comment #18)

(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".

We created a crates.io release workflow, but it fails here: https://github.com/eclipse-basyx/basyx-rust-sdk/runs/4351946202?check_suite_focus=true#step:4:3 (there is no token entered so the CLI is interpreted wrongly)

The respective CI line is this: https://github.com/eclipse-basyx/basyx-rust-sdk/blob/main/.github/workflows/release.yml#L30

Could you please double-check that the secret is accessible in the basyx-rust-sdk repo?

(In reply to Frank Schnicke from comment #20)

Could you please double-check that the secret is accessible in the
basyx-rust-sdk repo?

The secret is accessible by all public repos in the eclipse-basyx GitHub organization.
The following rule probably applies here:
"Secrets are not passed to workflows that are triggered by a pull request from a fork."
I would consider it to be a safety feature to not allow a (production) release on crates.io from a pull-request.

(In reply to Frederic Gurr from comment #21)

The secret is accessible by all public repos in the eclipse-basyx GitHub
organization.
The following rule probably applies here:
"Secrets are not passed to workflows that are triggered by a pull request
from a fork."
I would consider it to be a safety feature to not allow a (production)
release on crates.io from a pull-request.

Thanks, our job fails now at this stage: https://github.com/eclipse-basyx/basyx-rust-sdk/runs/4355186559?check_suite_focus=true#step:5:325

Apparently the Crates.io account must have a verified email address, according to this post: https://users.rust-lang.org/t/a-verified-email-address-will-be-required-to-publish-to-crates-io-starting-on-2019-02-28/22425

Could you please configure an email-address and verify it? The mail is only required for the crates.io staff to contact if something is wrong during crates.io operations.

(In reply to Frank Schnicke from comment #22)

Could you please configure an email-address and verify it? The mail is only
required for the crates.io staff to contact if something is wrong during
crates.io operations.

Done.

Done.

Many thanks.

We're preparing right now the next service release of BaSyx Java and would like to release it via GitHub workflows.

Would it be possible to configure the required secrets for releasing to Maven Central for basyx-java-sdk & basyx-java-components?

Currently we only support deploying to OSSRH/Maven Central via our Jenkins CI instances. We might support GitHub actions at a later point, but there is no timeline for it yet.

The migration to GitHub is done for all parts of the old repository.
Is there any way to mark the old repo as read-only, e.g., push to the repo or to Gerrit are automatically denied with a reference to GitHub?

(In reply to Frank Schnicke from comment #26)

Our usual workflow is to remove the Eclipse.org hosted repos, so it's a good idea to close any outstanding reviews before that.

-M.

I closed every outstanding review on Gerrit. We would like to keep the old repo as archive since the history was not preserved when migrating to GitHub. Thus, from our perspective putting it in read-only would be preferred.

Additionally, we're preparing the release of the basyx-python-sdk to PyPi. Would it be possible to prepare the required secrets for publishing to PyPi?

I closed every outstanding review on Gerrit. We would like to keep the old repo as archive since the history was not preserved when migrating to GitHub. Thus, from our perspective putting it in read-only would be preferred.

WDYT about pushing the old repo to GitHub and marking it as archived?

Additionally, we're preparing the release of the basyx-python-sdk to PyPi. Would it be possible to prepare the required secrets for publishing to PyPi?

PyPi.org account (user name: basyx-bot) and API token have been created. The token was added to the eclipse-basyx GitHub org secret (PYPI_ORG_TOKEN).

Many thanks for creating the PyPi secrets.

WDYT about pushing the old repo to GitHub and marking it as archived?

This would be fine with me. Is there any name preferred by Eclipse Foundation for this? Otherwise, basyx_archive would be a possibility.

Additionally, we would like to release documentation of the python SDK to readthedocs.io. I see that other Eclipse Projects are also releasing their documentation there. Would it be possible to configure the required secrets for the python SDK repository?

This would be fine with me. Is there any name preferred by Eclipse Foundation for this? Otherwise, basyx_archive would be a possibility.

I have created https://github.com/eclipse-basyx/basyx-archive (dash instead of underscore). Committers will gain access to this repo once the sync script runs (~2h).

Please push the old repo to this location. Please also add a note in the repo description (+Readme) that this was a single repo that has been split up into separate repos.

Many thanks, I pushed the original repository with its branches and added the note in the Readme. The repository can be marked as archived.

Ok. Repo has been marked as archived.

I just noticed: is it correct that the repo does not contain any tags?

Additionally, we would like to release documentation of the python SDK to readthedocs.io. I see that other Eclipse Projects are also releasing their documentation there. Would it be possible to configure the required secrets for the python SDK repository?

I have added a repository secret READTHEDOCS_ORG_TOKEN to https://github.com/eclipse-basyx/basyx-python-sdk/.

Hi,

I'm working on the BaSyx Python SDK project, together with @fschnicke.

How is the readthedocs Documentation meant to be published? As far as I know, a documentation project has to be created at readthedocs.org and integrated with the GitHub project via a web hook.

Is the readthedocs.org project already created? If so, where can we find it? If not, shall we create it ourselves or shall it be crated by the Eclipse Foundation?

Is the readthedocs.org project already created? If so, where can we find it? If not, shall we create it ourselves or shall it be crated by the Eclipse Foundation?

I was expecting this to work automatically as part of the integration with GitHub, but it didn't. I had to set it up manually.

It can be found here now: https://basyx-python-sdk.readthedocs.io/en/latest/

Thanks! :)

Many thanks again.

Would it be possible to change the logo of the Eclipse BaSyx organization to the following logo?

Done

closed

Can you please create a new repo called "basyx-dotnet". Thank you :)

I'm on it.

Would you mind reopening issues when you have additional requests on a ticket that has been closed? Thanks.

reopened

done https://github.com/eclipse-basyx/basyx-dotnet

closed

Dear all,

we would like to provide multiple demonstrators open source. Thus, would it be possible to create the basyx-demonstrators repository?

Best regards,

Frank

reopened

assigned to @fgurr

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

closed

Dear all,

we would like to provide an additional off-the-shelf component. For this, we would like to use an additional repository: basyx-databridge.

Would it be possible to create this repository?

Best regards, Frank

reopened

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

closed


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

[Bug 576137] Migrating BaSyx to GitHub

Description

Designs

Child items ...

Activity