Merge pull request #48 from Daespen/feature/docfxworkflow

Feature/docfxworkflow

Author: FrankSchnicke

.github/workflows/docfx-build-publish.yml

@@ -0,0 +1,29 @@
+# This workflow will build and publish documentation with docfx
+# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path
+
+name: Documentation Publish
+
+on:
+  push:
+    branches: 
+      - main
+
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+    name: Build and publish documentation
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+
+    - name: Build docfx
+      uses: nikeee/docfx-action@v1.0.0
+      with:
+        args: docs/docfx.json
+
+    - name: Publish
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_site
+        force_orphan: true

docs/articles/development_workflow.md

@@ -2,9 +2,9 @@
 
 We develop with Github using pull requests (see this [Github guide](https://guides.github.com/introduction/flow/) for a short introduction).
 
-**Development branch.** The development branch is always `master`. Expect changes on this branch from time to time.
+**Development branch.** The development branch is always `development`. Expect changes on this branch from time to time.
 
-**Releases.** The releases mark the development milestones on the `master` branch with a certain feature completeness.
+**Releases.** The releases mark the development milestones on the `main` branch with a certain feature completeness.
 
 ## Pull Requests
 
@@ -18,6 +18,12 @@ Otherwise, if you are a non-member contributor, fork the repository and create t
 
 **Reviews.** Each PullRequest is reviewed by the Maintainers of the project. In order to simplify the workflow, please assign the PullRequest directly to the Maintainer you think is most knowledgable about your changes.
 
+## CI Workflows
+There are three workflows that will automatically handle specific events for the repository: 
+- Pull requests on one of the branches mentioned above will trigger CI actions that will automatically check, if all tests pass successfully
+- Additionally, new commits on `main` will build the release artifacts and publish them on [Maven Central](https://mvnrepository.com/artifact/io.admin-shell.aas)
+- The documentation found in /docs is automatically build with docFX and published to gh-pages, when a new release is pushed to the `main` branch
+
 ## Commit Messages
 
 The commit messages should follow the guidelines from https://chris.beams.io/posts/git-commit: