Documentation: Difference between revisions

From pCT
← Older editNewer edit →
VisualWikitext
Mri083 (talk | contribs)
205 edits
→‎Making local working copy: moved to GitLab developer FAQ
Mri083 (talk | contribs)
205 edits
→‎Importing an external package: moved to GitLab master FAQ
Line 62: Line 62:
Or using the direct link
Or using the direct link
     git push https://user@gitlab.uib.no/user/wpn.git dev
     git push https://user@gitlab.uib.no/user/wpn.git dev
=== Importing an external package ===
The project will use a couple of external packages which are hosted in a different master repository. Copies of such external packages can be added to the gitlab server under our project group to provide a consistent package.
Here is a proposed workflow for importing a package which is already hosted in git.
# Create new repository in the pCT group or ask for creation, lets call it ''newPackage''
# Fork the repository to your user space
# Clone the package you want to import
#:<pre> git clone <some_external_link> newPackage # we give it the new name</pre>
#:<pre> cd newPackage</pre>
# Redirect upstream URL to the fork in your gitlab user space
#:<pre> git remote set-url origin https://user@gitlab.uib.no/user/newPackage.git</pre>
# Now make a forced push (option ''-f'') to import the repository to your fork
#:<pre> git push -f origin</pre>
# Create merge request to branch ''import'' (if not existing, ''master'' or any other appropriate branch) by following the instructions [[Documentation#Pull/Merge request | Pull/Merge request]]


== User documentation ==
== User documentation ==

Revision as of 10:24, 10 February 2021

Main Page -> Documentation

Mailing lists and collaborative tools

  • Project web page: has to come
  • General mailing list: pCT@uib.no
  • Slack project

Software installation

Software repository

We use the gitlab server hosted by IT of University of Bergen.

Get access to the repositories - with UiB account

Open the UiB gitlab web interface.

Log in with your UiB account, then the administrators will give you access to the pCT group. Since authentication goes via Dataporten service, accounts from other Norwegian universities or institutions can be used in the same way.

Get access to the repositories - without UiB account

It is possible to use a github user account to login to the UiB gitlab, however such external users are not allowed to create forks in the gitlab domain. Since forks are mandatory for the development cycle, github logins can effectively only be used for read access. Again the repository administrators need to add you to the pCT group.

Guest accounts for external developers can be set up, get in contact with the group over the general channels

Further information:

GitLab best practice

GitLab Developer FAQ

Gitlab Master FAQ

Development workflow

Every logged-in user can access the main repository, however only a small group of administrators has write access. To contribute, a user creates a fork (see here) from the repository. This is a repository copy in the Gitlab system where a single developer or a group of developers have full access.

A local copy of the repository is required on the working machine in order to work on the project. This copy is referred to be a clone (see here).

Pushing to development fork

Once you have added commits to e.g. the dev branch, those commits can be pushed upstream to the fork (if origin refers to the fork) 

   git push origin dev

Or using the direct link 

   git push https://user@gitlab.uib.no/user/wpn.git dev

User documentation

Retrieved from "https://pct.wiki.uib.no/index.php?title=Documentation&oldid=857"