Skip to content
Snippets Groups Projects
Commit 479135e5 authored by Benedikt Heinrichs's avatar Benedikt Heinrichs
Browse files

Add documentation

parent 0c282a6f
No related branches found
No related tags found
1 merge request!1New: Implement a general graph deployer
## C# Template
# GraphDeployer
This template includes:
This repository handles the deployment of every static graph which gets included into the CoScInE environment.
* Automatic building using cake
* Automatic testing with NUnit
* Automatic linting with Resharper
* Automatic documentation publishing using Gitlab CI / CD and a self written script which puts the docs in the docs folder to the wiki
* Automatic releases using semantic-release ([ESLint Code Convention](docs/ESLintConvention)), cake and Gitlab CI / CD
## Usage
## What you need to do
For every deployable graph repository, an entry is expected in the configuration path: `coscine/local/graphs/`.
Place you C# project solution file in .src/.
Make sure Create directory for solution is unticked.
![alt text](docs/images/create_project.png "Create a new Project")
Delete unused docs and update this README.
Add [NUnit](docs/nunit.md) tests to your solution.
## Building
Build this project by running either the build.ps1 or the build<span></span>.sh script.
The project will be build and tested.
### Links
* [Commit convention](docs/ESLintConvention.md)
* [Everything possible with markup](docs/testdoc.md)
* [Adding NUnit tests](docs/nunit.md)
\ No newline at end of file
Every repository MUST include the key `coscine/local/graphs/{graphname}/repositoryurl` for specifying the url (e.g. `git.rwth-aachen.de/coscine/applicationprofiles.git`) and CAN include the key `coscine/local/graphs/{graphname}/branch` which specifies the state of the repository being imported (e.g. `master`).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment