... | ... | @@ -11,70 +11,6 @@ See our installation instructions for Windows, Linux and Mac in the [BoSSS handb |
|
|
## Quickstart guides and Tutorials
|
|
|
See in our [BoSSS handbook](https://github.com/FDYdarmstadt/BoSSS/releases/latest).
|
|
|
|
|
|
## Workflow
|
|
|
The workflow of this repository is built arround one core principle: the master branch must be healthy. To achieve this, [merge trains](https://docs.gitlab.com/ee/ci/merge_request_pipelines/pipelines_for_merged_results/merge_trains/)
|
|
|
and continuous testing are combined, utilizing a protected master branch. From the user's perspective this boils down to: Instead of pushing your code into the repository you share your work by submitting a Merge Request.
|
|
|
View the [CI/CD Documentation](https://docs.gitlab.com/ee/ci/introduction/index.html#how-gitlab-cicd-works)
|
|
|
for more detail.
|
|
|
|
|
|
### Accessing Gitlab via SSH key
|
|
|
See the [GitLab help page](https://git.rwth-aachen.de/help/ssh/README)
|
|
|
|
|
|
### How to work with Gitlab
|
|
|
Before all, [clone the repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository). Alternatively, to change the remote of an already existing repo:
|
|
|
```bash
|
|
|
git remote rename origin old-origin
|
|
|
git remote add origin git@git.rwth-aachen.de:bosss1/experimental.git
|
|
|
```
|
|
|
|
|
|
Working with GitLab is straight forward:
|
|
|
1. Get the newest code:
|
|
|
```bash
|
|
|
git pull origin master
|
|
|
```
|
|
|
|
|
|
2. Create a new branch to work on:
|
|
|
```bash
|
|
|
git branch ArbitraryBranchName
|
|
|
git checkout ArbitraryBranchName
|
|
|
```
|
|
|
or
|
|
|
```bash
|
|
|
git checkout -b ArbitraryBranchName
|
|
|
```
|
|
|
|
|
|
3. Work on your code
|
|
|
|
|
|
4. Add your work to git:
|
|
|
```bash
|
|
|
git add -A
|
|
|
```
|
|
|
|
|
|
5. Commit your work and choose a commit message that shortly describes your work:
|
|
|
```bash
|
|
|
git commit -m "short descriptive message"
|
|
|
```
|
|
|
|
|
|
6. Share your work. Since the master branch is proteced, you have to push into a different branch. You can choose any name you deem suitable – as long as it is not already in use.
|
|
|
```bash
|
|
|
git push origin ArbitraryBranchName
|
|
|
```
|
|
|
|
|
|
7. Create a Merge Request: Navigate to MergeRequests in the GitLab Project menu to create a request to merge `ArbitraryBranchName` into master branch. After your code has been successfully tested select `Add to Merge Train` to finalize your merge.
|
|
|
|
|
|
To avoid using the web interface, you can also do
|
|
|
```bash
|
|
|
git push -o merge_request.create origin ArbitraryBranchName
|
|
|
```
|
|
|
instead of 6. and 7. Please note, that `origin` is only a name that can be different in your setting. Type `git remote -v` to check the names of your repositories. For more options, have a look at the [merge request options](https://docs.gitlab.com/ee/user/project/push_options.html).
|
|
|
|
|
|
That's it.
|
|
|
|
|
|
8. If the Merge Request fails: Remove Merge Conflicts and/or fix faulty code. Move to step 3.
|
|
|
|
|
|
For detailed information visit [GitLab Documentation](https://docs.gitlab.com/ee/user/index.html).
|
|
|
|
|
|
|
|
|
## Note for publication
|
|
|
If you are using BoSSS for one of your publications, we kindly ask you to cite one of our own publications, which corresponds most to your work. Look at
|
|
|
at [Publications](https://www.fdy.tu-darmstadt.de/fdyresearch/bossscode/bosss_publications/publications.en.jsp)
|
... | ... | |