Questions regarding co-creation

Github is an ideal place to work together with colleagues and also external parties. In the new organization https://github.com/Deltares-research, there are a few ways to work with outside collaborators:


  1. Use PULL REQUESTS. Allow your repository to accept pull requests. This way collaborators do not require to be added (and managed) as 'Outside collaborators'. This works well for PUBLIC repositories.
  2. Invite an outside collaborator to your organization and then assign them to your repository. For PUBLIC repositories no license is claimed for PRIVATE repositories 1 license is claimed. No additional costs for adding the same collaborator to multiple repositories.

Inviting 'outside collaborators' to your repository:

Login to GITHUB and go to the settings of your repository then continue to 'Collaborators and teams'. Here you can 'Add people'. In the popup form enter either the GITHUB username or the e-mails address of the user you wish to invite and set the role for this user.

The user will receive an invitation by e-mail and also under the users GITHUB settings in the section Organizations. The user must accept the invitation (either in e-mail or under settings) to become outside collaborator.


MyDeltares account

An outside collaborator is not required to authenticate through the MyDeltares identity provider and therefore does not require a MyDeltares account

Firstly, what is the difference between a Member and Outside-collaborator? 

Information that can help answer to this question can be found here: About conversion of organization members to outside collaborators. In short outside collaborators are more limited than members.

Inviting Members

Inviting users as members to your organization is managed from the 'People' menu in your Organization. Here outside-collaborators can be promoted to members or members can be invited directly. This is something you can probably not do yourself and you will have to send a request to: github-support@deltares.nl or on the public WIKI Submit a Question.

The user will receive an invitation by e-mail or will be able to Accept the invitation under users GITHUB settings in the section Organizations (see How to invite outside-collaborators question above).

On accepting the invitation the user will be asked to join the organization which will require that the users logs into MyDeltares:



If the user does not have a MyDeltares account the the user can create an account (free-of-charge) by following the link 'Create a MyDeltares account' and providing the requested information. 


Invite members using e-mail: It is important to know that when inviting Deltares colleagues, you must invite them using their Deltares e-mail address. This assures that all Deltares members can be managed by the Deltares ICT department.

Questions relating to migration

I want to use my own Github account that I've used thus far (linked to my private e-mail address). Can I do that and if yes, how?

It is possible to use your existing GITHUB account. However if you work for Deltares, you will have to assign your Deltares email to your GITHUB account. All Deltares employees will be invited using their Deltares email address.

Problem

I want to request a new Github repository for my project or software product, but I do not know which of the two Deltares organizations I must choose: Deltares or Deltares-research

Solution

You do not need to choose anything, this will be done for you based on the information provided during the registration process.

What is the difference between the two organizations?

Deltares organization: This organization is meant to house all repositories that are linked to a Product Management Team (PMT) and contain production ripe software.

Deltares-research: All repositories that do not fit into the Deltares organization.

Problem

After your repository is moved from https://github.com/Deltares to the new organization https://github.com/Deltares-research, it is possible that you are required to re-authorize your account in one or more of your local applications, such as VS Code, TortoiseGIT or on the GIT command line.

Solution

Follow the following steps to refresh you authorization token:

  1. Open the Credential Manager in Widows. ( type 'Credential Manager')
  2. In Credential Manager select 'Windows Credentials'


  3. Lookup the credentials for git:https://github.com and remove this.
  4. Re-initialise the cred manager in git bash: git config --global credential.helper manager-core
  5. Re-run git pull and follow the pop-up instructions to authenticate in a browser (which happened automatically for me with SSO).


No there is not.

When you have questions regarding the new GITHUB environment you can post them to the GITHUB support team. We can then try to connect you to people who already have experience with GITHUB. Otherwise we suggest you contact your department head for funding.

There is no fixed definition of 'production-ripe' software. It is up to the Product Management Teams (PMT) to decide if they wish to designate certain repositories / products as production ripe or as research. 

All repositories under the Deltares organisations should be linked to one of the PMT;s. If unsure about the status of your repository please contact the PMT and discuss with them where your repository fits best.

If you have been working on a software product for Deltares, but you have created the repository under your own personal Github account, you might want to move that repository to a Deltares Github organization. This can be achieved by transferring the ownership of your repository. 


Before transferring ownership, there are some preconditions that need to be met:

Preconditions

  1. You must be a member in the Deltares organization
  2. Your repository must be set to PUBLIC. The visibility of your repository can be set back to PRIVATE after transfer.
  3. It is only possible to transfer ownership to the Deltares-research organization. After transfer it will be possible to transfer your repository to the Deltares organization.


Once these preconditions have been met, you can start the transfer process by opening the Settings for your repository:

In the General section, scroll all the way down to the Danger Zone. Here you will find the option Transfer


As New owner you must choose Deltares-research. This option should be visible from the drop-down list.

In the bottom filed type the text stated in the message and press the button 'I understand, transfer this repository'


Questions relating to applications

In the current Deltares organization, co-pilot has been enabled. There are 24 licenses available, all of which are currently taken. At present co-pilot is not enabled in the Deltares-research organization. This will change once the Deltares organization has been added to the Deltares enterprise.

How we plan to use co-pilot in the future and how we plan to manage the licenses has not yet been worked out. For more information please contact: github-owners@deltares.nl .

Apparently some users can no longer see their repositories in Zenodo. Even when their repositories have not been moved from the Deltares organization. Why this is the case is still unclear however the resolution is that one of the organization owners logs into Zenodo using ones Github account and activates the required repositories.

Deltares does not support the use of GITHUB's own Large File Storage (LFS) environment. However it is possible to connect your repository to the Deltares S3 bucket (MinIO) using GIT-LFS.

Please read the information on the following page: GitHub - How to connect your repository to a LFS?:

If you wish to connect your repository to the Data Version Control (DVC) tool, then please read the information on the following page: GitHub - How to connect your repository to a LFS?:

When you create a personal access token , this needs to be approved by one of the Github owners. To assure that this is done, you are requested to send an email to github.support@deltares.nl explaining your request.

Codecov is not updating anymore since it requires a token now. This can be fixed by replacing:

   
 - uses: codecov/codecov-action@v1

with:

 - uses: codecov/codecov-action@v4
   env:
   CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
  • No labels

Disclaimer