Merge branch 'tarantool:master' into abelyaev/sql_statements

Author: AnastasMIPT

.github/workflows/destroy-deployment.yml

@@ -0,0 +1,24 @@
+name: Destroy-deployments
+
+on:
+  pull_request:
+    paths:
+      - 'doc/**/*'
+    types:
+      - closed
+jobs:
+  destroy-deployment:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Set branch name from source branch
+        run: echo "BRANCH_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
+
+      - name: Remove dev server deployment at ${{env.DEPLOYMENT_NAME}}
+        uses: strumwolf/delete-deployment-environment@v2
+        with:
+          token: "${{ secrets.TARANTOOLBOT_TOKEN }}"
+          environment: "translation-${{env.BRANCH_NAME}}"

.github/workflows/pull-translation.yml

@@ -0,0 +1,51 @@
+name: Pull translations
+
+on:
+  workflow_dispatch:
+    branches:
+      - '!master'
+jobs:
+  pull-translations:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: ${{secrets.TARANTOOLBOT_TOKEN}}
+
+      - name: Set branch name from source branch
+        run: echo "BRANCH_NAME=${GITHUB_REF##*/}" >> $GITHUB_ENV
+
+      - name: Setup Python environment
+        uses: actions/setup-python@v2
+
+      - name: Setup Python requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r doc/requirements.txt
+
+      - name: Pull translations from Crowdin
+        uses: crowdin/[email protected]
+        with:
+          config: 'doc/crowdin.yaml'
+          upload_sources: false
+          upload_translations: false
+          push_translations: false
+          download_translations: true
+          download_language: 'ru'
+          crowdin_branch_name: ${{env.BRANCH_NAME}}
+          debug_mode: true
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          CROWDIN_PERSONAL_TOKEN: ${{secrets.CROWDIN_PERSONAL_TOKEN}}
+
+      - name: Cleanup translation files
+        run: |
+          sudo chown -R runner:docker doc/locale/ru/LC_MESSAGES
+          python doc/cleanup.py po
+
+      - name: Commit translation files
+        uses: stefanzweifel/[email protected]
+        with:
+          commit_message: "Update translations"
+          file_pattern: "*.po"

.github/workflows/push-translation.yml

@@ -0,0 +1,55 @@
+name: Push translation sources
+
+on:
+  pull_request:
+    paths:
+      - 'doc/**/*'
+jobs:
+  push-translation-sources:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set branch name from source branch
+        run: echo "BRANCH_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
+
+      - name: Start translation service deployment
+        uses: bobheadxi/[email protected]
+        id: translation
+        with:
+          step: start
+          token: ${{secrets.GITHUB_TOKEN}}
+          env: translation-${{env.BRANCH_NAME}}
+          ref: ${{github.head_ref}}
+
+      - name: Setup Python environment
+        uses: actions/setup-python@v2
+
+      - name: Setup Python requirements
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r doc/requirements.txt
+
+      - name: Build pot files
+        run: python -m sphinx . doc/locale/en -c doc -b gettext
+
+      - name: Push POT files to crowdin
+        uses: crowdin/[email protected]
+        with:
+          upload_sources: true
+          upload_translations: false
+          crowdin_branch_name: ${{env.BRANCH_NAME}}
+          config: 'doc/crowdin.yaml'
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          CROWDIN_PERSONAL_TOKEN: ${{secrets.CROWDIN_PERSONAL_TOKEN}}
+
+      - name: update deployment status
+        uses: bobheadxi/[email protected]
+        with:
+          step: finish
+          token: ${{secrets.GITHUB_TOKEN}}
+          status: ${{job.status}}
+          deployment_id: ${{steps.translation.outputs.deployment_id}}
+          env_url: https://crowdin.com/project/tarantool-cpp/ru#/${{env.BRANCH_NAME}}

.github/workflows/upload-translations.yml

@@ -0,0 +1,38 @@
+name: Update translations on the main branch
+
+on:
+  push:
+    paths:
+      - 'doc/**/*'
+    branches:
+      - master
+jobs:
+  autocommit-pot-files:
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Setup Python environment
+      uses: actions/setup-python@v2
+
+    - name: Setup Python requirements
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r doc/requirements.txt
+
+    - name: Build pot files
+      run: python -m sphinx . doc/locale/en -c doc -b gettext
+
+    - name: Push Pot-files to crowdin
+      uses: crowdin/[email protected]
+      with:
+        config: 'doc/crowdin.yaml'
+        upload_sources: true
+        upload_translations: true
+        import_eq_suggestions: true
+      env:
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        CROWDIN_PERSONAL_TOKEN: ${{secrets.CROWDIN_PERSONAL_TOKEN}}

.gitignore

@@ -26,3 +26,7 @@
 *.exe
 *.out
 *.app
+
+# Documentation builds
+doc/locale/en/
+doc/output

doc/README.md

@@ -0,0 +1,20 @@
+[![Crowdin](https://badges.crowdin.net/tarantool-cpp/localized.svg)](https://crowdin.com)
+
+# Tarantool Tarantool C++ Connector documentation
+Part of Tarantool documentation, published to 
+https://www.tarantool.io/en/doc/latest/getting_started/getting_started_cxx/
+
+### Create pot files from rst
+```bash
+python -m sphinx . doc/locale/en -c doc -b gettext
+```
+
+### Create/update po from pot files
+```bash
+sphinx-intl update -p doc/locale/en -d doc/locale -l ru
+```
+
+### Build documentation to doc/output
+```bash
+python -m sphinx . doc/output -c doc
+```

doc/cleanup.py

@@ -0,0 +1,46 @@
+#! /usr/bin/env python3
+import argparse
+from glob import glob
+from polib import pofile, POFile, _BaseFile
+
+parser = argparse.ArgumentParser(description='Cleanup PO and POT files')
+parser.add_argument('extension', type=str, choices=['po', 'pot', 'both'],
+                    help='cleanup files with extension: po, pot or both')
+
+
+class PoFile(POFile):
+
+    def __unicode__(self):
+        return _BaseFile.__unicode__(self)
+
+    def metadata_as_entry(self):
+        class M:
+            def __unicode__(self, _):
+                return ''
+        return M()
+
+
+def cleanup_files(extension):
+    mask = f'**/*.{extension}'
+    for file_path in glob(mask, recursive=True):
+        print(f'cleanup {file_path}')
+        po_file: POFile = pofile(file_path, klass=PoFile)
+        po_file.header = ''
+        po_file.metadata = {}
+        po_file.metadata_is_fuzzy = False
+
+        for item in po_file:
+            item.occurrences = None
+
+        po_file.save()
+
+
+if __name__ == "__main__":
+
+    args = parser.parse_args()
+
+    if args.extension in ['po', 'both']:
+        cleanup_files('po')
+
+    if args.extension in ['pot', 'both']:
+        cleanup_files('pot')

doc/conf.py

@@ -0,0 +1,23 @@
+import sys
+import os
+
+sys.path.insert(0, os.path.abspath(''))
+
+master_doc = 'doc/tntcxx_getting_started'
+
+source_suffix = '.rst'
+
+project = u'tntcxx'
+
+exclude_patterns = [
+    'doc/locale',
+    'doc/output',
+    'doc/README.md',
+    'doc/cleanup.py',
+    'doc/requirements.txt',
+]
+
+language = 'en'
+locale_dirs = ['./doc/locale']
+gettext_compact = False
+gettext_location = True

doc/crowdin.yaml

@@ -0,0 +1,24 @@
+# https://support.crowdin.com/configuration-file/
+# https://support.crowdin.com/cli-tool-v3/#configuration
+
+"project_id" : "457586"
+"base_path" : "doc/locale"
+"base_url": "https://crowdin.com"
+"api_token_env": "CROWDIN_PERSONAL_TOKEN"
+
+
+"preserve_hierarchy": true
+
+files: [
+ {
+  "source" : "/en/**/*.pot",
+  "translation" : "/%locale_with_underscore%/LC_MESSAGES/**/%file_name%.po",
+  "update_option" : "update_as_unapproved",
+
+  "languages_mapping" : {
+    "locale_with_underscore" : {
+      "ru" : "ru",
+     }
+  },
+ }
+]