From 1bbdc3ec80ea004bd8c10f2d4b4b4a85635ead79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Kilchenmann?= Date: Wed, 28 Oct 2020 21:12:00 +0100 Subject: [PATCH] DSP-917 Releases pushed to Dockerhub from DSP-API are "dirty" (#1744) * chore(CI): Update publish process * docs(docs): Fix typo and format of README Co-authored-by: Ivan Subotic <400790+subotic@users.noreply.github.com> --- .github/workflows/main.yml | 24 ++++++++++++------------ docs/Readme.md | 32 ++++++++++++++------------------ 2 files changed, 26 insertions(+), 30 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 501ae985b5..1038ff4387 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -335,7 +335,7 @@ jobs: with: java-version: '11' # The OpenJDK version to make available on the path architecture: 'x64' # defaults to 'x64' - - name: install requirements + - name: Install requirements run: sudo apt-get install ca-certificates-java expect redis-tools unzip - name: Set up Python 3.8 uses: actions/setup-python@v2 @@ -352,21 +352,16 @@ jobs: npm install --global typedoc npm install --global @bazel/bazelisk sudo apt-get install graphviz - - name: generate api-client-test-data + - name: Generate api-client-test-data run: make client-test-data - - name: add api-client-test-data to release assets + - name: Add api-client-test-data to release assets uses: svenstaro/upload-release-action@v2 with: repo_token: ${{ secrets.GH_TOKEN }} file: client-test-data.zip tag: ${{ github.ref }} overwrite: true - - name: deploy docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - env: - GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} - CUSTOM_DOMAIN: docs.knora.org - - name: cache maven artifacts + - name: Cache maven artifacts uses: actions/cache@v1 with: path: ~/.ivy2 @@ -375,17 +370,22 @@ jobs: ${{ runner.OS }}-build-${{ env.cache-name }}- ${{ runner.OS }}-build- ${{ runner.OS }}- - - name: disk Free + - name: Disk Free run: | df -h docker system df docker system prune --all --force --volumes df -h - - name: build and publish all images to Dockerhub + - name: Build and publish all images to Dockerhub run: | echo ${{ secrets.DOCKER_HUB_TOKEN }} | docker login -u ${{ secrets.DOCKER_USER }} --password-stdin make docker-publish - - name: disk Free After + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GH_TOKEN }} + CUSTOM_DOMAIN: docs.knora.org + - name: Disk Free After run: | df -h docker system df diff --git a/docs/Readme.md b/docs/Readme.md index 9474336526..49ef737c98 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -7,30 +7,30 @@ under [http://docs.knora.org](http://docs.knora.org). The `src` folder contains the following documentation sources: - - `src/api-v1`: The Knora JSON API V1 Request and Response Format documentation. Source can be found in `salsah1/src/typescript_interfaces` - - `src/api-v2`: The Knora JSON-LD API V2 Request and Response Format documentation. - - `src/api-admin`: The Knora JSON Admin API Request and Response format Swagger-based documentation. +- `src/api-v1`: The Knora JSON API V1 Request and Response Format documentation. Source can be found in `salsah1/src/typescript_interfaces` +- `src/api-v2`: The Knora JSON-LD API V2 Request and Response Format documentation. +- `src/api-admin`: The Knora JSON Admin API Request and Response format Swagger-based documentation. All the different documentations are build by invoking the following make commands from the project root directory: -``` -$ make docs-buld # build the documentation -$ make docs-serve # serve it locally -$ make docs-publish # publish it do Github pages -$ make docs-install-requirements: ## install requirements +```shell +make docs-build # build the documentation +make docs-serve # serve it locally +make docs-publish # publish it do Github pages +make docs-install-requirements: ## install requirements ``` This command will build all documentation and publish it to the `gh-pages` branch. -## Prerequisites +## Prerequisites 1. You will need [Graphviz](http://www.graphviz.org/). On macOS: + ```shell + brew install graphviz ``` - $ brew install graphviz - ``` - + On Linux, use your distribution's package manager. 1. The Knora JSON API V1 / V2 Request and Response Format documentation is @@ -39,13 +39,9 @@ from these interfaces, we use `typedoc`. Install `typedoc` using `npm`: - ``` - npm install --global typedoc + ```shell + npm install --global typedoc ``` If you do not have `npm` (node package manager), install it first. You will find more information about `npm` here: . - - - -