ITADMIN - Add instructions for manual backup (#24)

Author: fegbers

.github/workflows/nightly.yml

@@ -1,18 +1,30 @@
+# This configuration is used for nightly builds
 name: nightly
 
 on:
   schedule:
-    - cron: 0 0 * * 1
+    # Runs every Monday at 00:00
+    - cron: 0 0 * * MON
 
 jobs:
   nightly:
     timeout-minutes: 30
     runs-on: ubuntu-latest
 
     steps:
+      # Checkout the git repository
       - name: checkout
         uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+          token: ${{ secrets.GPR_TOKEN }}
+          fetch-depth: ''
+
+      # Execute some necessary git commands to get more repository informations
+      - name: post-checkout
+        run: git fetch --prune --unshallow
 
+      # Get the current project version from version.txt
       - name: get-project-version
         id: get_project_version
         uses: avides/actions-project-version-check@v1
@@ -21,6 +33,7 @@ jobs:
           file-to-check: version.txt
           only-return-version: true
 
+      # Build docker image
       - name: build-image
         env:
           PROJECT_VERSION: ${{ steps.get_project_version.outputs.version }}

.github/workflows/release.yml

@@ -1,8 +1,10 @@
+# This configuration is used for the deployment and publish to docker
 name: release
 
 on:
   push:
     branches:
+      # Runs only on push to the master branch
       - master
 
 jobs:
@@ -13,9 +15,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      # Checkout the git repository
       - name: checkout
         uses: actions/checkout@v2
+        with:
+          ref: ${{ github.head_ref }}
+          token: ${{ secrets.GPR_TOKEN }}
+          fetch-depth: ''
+
+      # Execute some necessary git commands to get more repository informations
+      - name: post-checkout
+        run: git fetch --prune --unshallow
 
+      # Get the current project version from POM
       - name: get-project-version
         id: get_project_version
         uses: avides/actions-project-version-check@v1
@@ -24,6 +36,7 @@ jobs:
           file-to-check: version.txt
           only-return-version: true
 
+      # Build and publish docker image
       - name: push-image
         env:
           PROJECT_VERSION: ${{ steps.get_project_version.outputs.version }}
@@ -35,6 +48,7 @@ jobs:
             docker push ${{ secrets.DOCKER_REGISTRY }}/${GITHUB_REPOSITORY}:latest
           fi
 
+      # Get last commit message for GitHub Release tag
       - name: setup-github-release
         id: setup_github_release
         env:
@@ -45,6 +59,7 @@ jobs:
             echo ::set-output name=isprerelease::true
           fi
 
+      # Create and publish GitHub Release tag
       - name: github-release
         uses: actions/create-release@v1
         env:

.github/workflows/review.yml

@@ -1,7 +1,9 @@
+# This configuration is used for the pull request review
 name: review
 
 on:
   pull_request:
+    # Runs only on pull request creation and on every new commit to the created pull request
     types: [opened, synchronize]
 
 jobs:
@@ -10,24 +12,33 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      # Cancels previous run for this branch that have a different commit id (SHA)
+      - name: cancel-previous-run
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+      # Checkout the git repository
       - name: checkout
         uses: actions/checkout@v2
         with:
           ref: ${{ github.head_ref }}
           token: ${{ secrets.GPR_TOKEN }}
           fetch-depth: ''
 
+      # Execute some necessary git commands to get more repository informations
       - name: post-checkout
         run: git fetch --prune --unshallow
 
+      # Update GitHub Action configuration if necessary
       - name: action-configuration-autoupdate
-        id: actions_action_configuration_autoupdate
         uses: avides/actions-action-configuration-autoupdate@v1
         with:
           token: ${{ secrets.GPR_TOKEN }}
           actions-configuration-files: plain-docker-application/nightly.yml,plain-docker-application/release.yml,plain-docker-application/review.yml
           source-repository: ${{ secrets.ACTIONS_CONFIG_AUTOUPDATE_REPO }}
 
+      # Push updated GitHub Actions configuration if necessary
       - uses: stefanzweifel/git-auto-commit-action@v4
         with:
           file_pattern: .github/workflows/*.yml
@@ -36,17 +47,34 @@ jobs:
           commit_author: ${{ secrets.ACTIONS_CONFIG_AUTOUPDATE_AUTHOR }}
           commit_message: Update GitHub Action configuration
 
-      - name: action-configuration-updated
-        if: ${{ steps.actions_action_configuration_autoupdate.outputs.updated }}
-        run: exit 1;
-
+      # Verify project version is updated
       - name: project-version-check
         id: project_version_check
         uses: avides/actions-project-version-check@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           file-to-check: version.txt
 
+      # Check if documentation reminder comment is already given
+      - name: find-documentation-reminder-comment
+        uses: peter-evans/find-comment@v1
+        id: find_documentation_reminder_comment
+        with:
+          issue-number: ${{ github.event.number }}
+          body-includes: "Confluence/GitHub documentation added or updated?"
+
+      # Add documentation reminder comment if not given
+      - name: documentation-reminder-comment
+        uses: jungwinter/comment@v1
+        id: create
+        if: ${{ steps.find_documentation_reminder_comment.outputs.comment-id == 0 }}
+        with:
+          type: create
+          body: 'Confluence/GitHub documentation added or updated?'
+          issue_number: ${{ github.event.number }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      # Build docker image
       - name: build-image
         env:
           PROJECT_VERSION: ${{ steps.project_version_check.outputs.version }}

README.md

@@ -59,6 +59,16 @@ docker logs -f mysql-s3-backup
 docker exec -it mysql-s3-backup /bin/bash
 ```
 
+### Trigger backup manually
+Caution: Please avoid concurrent backup processes (e.g. via cron & manual backup)!
+
+The following command must be executed inside the container.
+Therefore, you must log in inside the container or pass the command to the container. 
+
+```shell
+/root/backup.sh >> /var/log/backup-cron/cron.log
+```
+
 ## Metrics
 
 This container delivers some metrics about the MySQL backups. The metrics are available to the HTTP endpoint "/metrics" on port 9300. Following metrics are collected:

version.txt

@@ -1 +1 @@
-2.6.0
+2.7.0