diff --git a/README.md b/README.md index 9fe780e..f18ff3b 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Visualization and analysis of git commit statistics. Performance tool for Team L **Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 Employee can evaluate new workplace @@ -48,7 +48,6 @@ Visualization and analysis of git commit statistics. Performance tool for Team L - [Use the library PHP](#link-14) - [Use the library Python](#link-15) - [Use the library Ruby](#link-16) - - [Use the library Go](#link-165) - [Use source code](#link-17) - [How to rebuild the HTML report from source code?](#link-18) - [How to view a report on a group of microservices?](#link-19) @@ -61,9 +60,9 @@ Visualization and analysis of git commit statistics. Performance tool for Team L - [With backend](#link-26) - [Without backend](#link-27) - [DevOps ](#link-28) - - [Public server](#link-29) - - [Private server](#link-30) - - [How to update the Docker image?](#link-31) + - [Github Actions](#link-29) + - [Public server](#link-30) + - [Private server](#link-31) - [️ About application](#link-32) - [Architecture](#link-33) - [How to add or edit a translation?](#link-34) @@ -145,7 +144,7 @@ Or open a saved file and manually change the encoding to UTF-8. #### Using website - go to the [website](https://bakhirev.github.io/); -- click the “[Demo](https://bakhirev.github.io/demo?ref=github&lang=en)” button; +- click the “[Demo](https://bakhirev.github.io/demo)” button; - drop the `log.txt` file into the browser window; #### Use the library NodeJS @@ -165,12 +164,6 @@ Or open a saved file and manually change the encoding to UTF-8. #### Use the library Ruby - run `gem install assayo` - run `assayo` -- open `./assayo/index.html` - -#### Use the library Go -- run `go get github.com/bakhirev/assayo` -- run `go install github.com/bakhirev/assayo` -- run `assayo` - open `./assayo/index.html` #### Use source code @@ -196,9 +189,8 @@ You can create your own interface theme. Options: - **Title**. You can set default document title in the URL parameter ```title```. Example: ```?title=You Company``` - **Visual theme**. To do this, you need to prepare a CSS file with new styles and specify its URL in the ```theme``` parameter. Example: ```?theme=//company.com/some.css```. You can use class names as selectors. Most of them do not change in new versions. - **Language**. You can set language in the URL parameter ```lang```. Example: ```?lang=es``` - -**Example:** [page](https://bakhirev.github.io/demo/themes/) - + **Example:** [demo](https://bakhirev.github.io/demo/themes/) + ### 📝 How to sign commits? Follow the [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). Example: ``` @@ -248,12 +240,18 @@ fi ### 🛠️ DevOps (CI/CD) +#### Github Actions +Use Github Actions to automatically create a report within your builds. +- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace; +- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action; + I recommend using the first option. It is more stable and increases the statistics of installations. + #### Public server You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://bakhirev.github.io/?ref=github&lang=en) to visualize it. ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### Private server - download the [docker image](https://hub.docker.com/r/bakhirev/assayo); - run it on your local network; @@ -264,14 +262,7 @@ assayo_url - URL of the assayo container, it listens on port 80; you_url - URL of your container with git logs; ``` By default, the image will run at ```http://127.0.0.1:80/```. If it doesn't work, check if port 80 is free. - -#### How to update the Docker image? -- run ```npm run build:docker``` -- run ```docker build -t assayo .``` -- visually check the image ```docker run --name assayo -p 80:80 -d assayo```; -- add tag ```docker tag assayo bakhirev/assayo:latest```; -- push image to [Docker Hub](https://hub.docker.com/r/bakhirev/assayo) ```docker push bakhirev/assayo:latest```; - + ### 🛠️ ️ About application #### 📐 Architecture @@ -295,7 +286,7 @@ Releases are planned approximately once every six months. What’s next: - development of the backend, integration with other systems; #### 📧 Feedback, comments -- Telegram Messenger [@bakhirev](https://t.me/bakhirev) (preferred method of communication) +- 📱 [https://t.me/bakhirev](https://t.me/bakhirev) (priority method of communication) - 📧 [alexey-bakhirev@yandex.ru](mailto:alexey-bakhirev@yandex.ru) - 🌐 [https://bakhirev.github.io/](https://bakhirev.github.io/?ref=github&lang=en) diff --git a/documents/ActionExample.yml b/documents/ActionExample.yml new file mode 100644 index 0000000..994bd69 --- /dev/null +++ b/documents/ActionExample.yml @@ -0,0 +1,46 @@ +# Creates an HTML report +# with analysis of commit statistics. +# +# More information: https://github.com/bakhirev/assayo +name: Assayo + +on: + # Run by time + # (if you have a lot of people and frequent commits) + # Remove this for small teams: + schedule: + - cron: '0 0 */5 * *' + + # Run by PR + # (if you have few people and commits are rarely made) + # Remove this for big teams: + pull_request: + types: [closed] + push: + tags: + - '*' + branches: + - main + - develop + - 'release/**' + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Create report + run: | + git clone https://github.com/bakhirev/assayo.git + git --no-pager log --raw --numstat --oneline --all --reverse --date=iso-strict --pretty=format:"%ad>%aN>%aE>%s" | sed -e 's/\\/\\\\/g' | sed -e 's/`/"/g' | sed -e 's/\$/S/g' | sed -e '1s/^/R(f\`/' | sed -e '$s/$/\`\);/' > ./assayo/build/log.txt + + - name: Archive the report as an artifact + uses: actions/upload-artifact@v4 + with: + name: Commit statistics report + path: ./assayo/build/ diff --git a/documents/DE.md b/documents/DE.md index e039bf2..3093fbe 100644 --- a/documents/DE.md +++ b/documents/DE.md @@ -3,11 +3,13 @@ # [Assayo](https://bakhirev.github.io/?ref=github&lang=de) Visualisierung und analyse ihrer git-datenbank. Performance tool for Team Lead and IT-audit + **Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/). + **Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 Mitarbeiter können den neuen arbeitsplatz bewerten @@ -57,9 +59,9 @@ Visualisierung und analyse ihrer git-datenbank. Performance tool for Team Lead a - [With backend](#link-26) - [Kein bekend](#link-27) - [DevOps ](#link-28) - - [Öffentlicher server](#link-29) - - [Privater server](#link-30) - - [Aktualisieren eines Docker-Images](#link-31) + - [Github Actions](#link-29) + - [Öffentlicher server](#link-30) + - [Privater server](#link-31) - [️ About application](#link-32) - [Architecture](#link-33) - [Veröffentlichungen, ungefähr alle sechs monate. Was weiter:](#link-34) @@ -237,12 +239,18 @@ Jedes mal, wenn der computer neu gestartet wird, aktualisiert das skript die sta ### 🛠️ DevOps (CI/CD) +#### Github Actions +Use Github Actions to automatically create a report within your builds. +- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace; +- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action; +I recommend using the first option. It is more stable and increases the statistics of installations. + #### Öffentlicher server Sie können eine datendatei zum erstellen eines berichts auf eine öffentliche URL hochladen. Sie können die Website verwenden, um sie zu visualisieren [assayo](https://bakhirev.github.io/). Geben sie im URL-parameter die adresse an, an der die daten liegen ```dump```: ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### Privater server - herunterladen [docker das bild](https://hub.docker.com/r/bakhirev/assayo); - führen Sie es im lokalen netzwerk aus; @@ -253,13 +261,6 @@ assayo_url - die adresse des assayo-containers, er hört auf port 80; you_url - URL die adresse ihres containers mit git-logs; ``` Standardmäßig wird das abbild an der folgenden adresse ausgeführt ```http://127.0.0.1:80/```. Wenn es nicht funktioniert, überprüfen sie, ob der port 80 frei ist. - -#### Aktualisieren eines Docker-Images -- befehl ausführen ```npm run build:docker``` -- befehl ausführen ```docker build -t assayo .``` -- ergebnis überprüfen ```docker run --name assayo -p 80:80 -d assayo```; -- befehl ausführen ```docker tag assayo bakhirev/assayo:latest```; -- senden sie ein containerimage an Docker Hub ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ About application diff --git a/documents/EN.md b/documents/EN.md index 0d05078..ee7c351 100644 --- a/documents/EN.md +++ b/documents/EN.md @@ -4,11 +4,13 @@ # [Assayo](https://bakhirev.github.io/?ref=github&lang=en) Visualization and analysis of git commit statistics. Performance tool for Team Lead and IT-audit + **Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/). + **Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 Employee can evaluate new workplace @@ -58,9 +60,9 @@ Visualization and analysis of git commit statistics. Performance tool for Team L - [With backend](#link-26) - [Without backend](#link-27) - [DevOps ](#link-28) - - [Public server](#link-29) - - [Private server](#link-30) - - [How to update the Docker image?](#link-31) + - [Github Actions](#link-29) + - [Public server](#link-30) + - [Private server](#link-31) - [️ About application](#link-32) - [Architecture](#link-33) - [How to add or edit a translation?](#link-34) @@ -142,7 +144,7 @@ Or open a saved file and manually change the encoding to UTF-8. #### Using website - go to the [website](https://bakhirev.github.io/); -- click the “[Demo](https://bakhirev.github.io/demo?ref=github)” button; +- click the “[Demo](https://bakhirev.github.io/demo)” button; - drop the `log.txt` file into the browser window; #### Use the library NodeJS @@ -238,12 +240,18 @@ fi ### 🛠️ DevOps (CI/CD) +#### Github Actions +Use Github Actions to automatically create a report within your builds. +- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace; +- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action; +I recommend using the first option. It is more stable and increases the statistics of installations. + #### Public server You can upload the data file for report construction to a public URL. And use the website’s [assayo](https://bakhirev.github.io/?ref=github&lang=en) to visualize it. ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### Private server - download the [docker image](https://hub.docker.com/r/bakhirev/assayo); - run it on your local network; @@ -254,13 +262,6 @@ assayo_url - URL of the assayo container, it listens on port 80; you_url - URL of your container with git logs; ``` By default, the image will run at ```http://127.0.0.1:80/```. If it doesn't work, check if port 80 is free. - -#### How to update the Docker image? -- run ```npm run build:docker``` -- run ```docker build -t assayo .``` -- visually check the image ```docker run --name assayo -p 80:80 -d assayo```; -- add tag ```docker tag assayo bakhirev/assayo:latest```; -- push image to [Docker Hub](https://hub.docker.com/r/bakhirev/assayo) ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ About application diff --git a/documents/ES.md b/documents/ES.md index 9a5379d..a507613 100644 --- a/documents/ES.md +++ b/documents/ES.md @@ -4,11 +4,13 @@ # [Assayo](https://bakhirev.github.io/?ref=github&lang=es) Visualización y análisis de los datos de su repositorio git. Performance tool for Team Lead and IT-audit + **Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/). + **Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 El empleado puede evaluar el nuevo lugar de trabajo @@ -58,9 +60,9 @@ Visualización y análisis de los datos de su repositorio git. Performance tool - [With backend](#link-26) - [Sin backend](#link-27) - [DevOps ](#link-28) - - [Servidor público](#link-29) - - [Servidor privado](#link-30) - - [Actualización de la imagen Docker](#link-31) + - [Github Actions](#link-29) + - [Servidor público](#link-30) + - [Servidor privado](#link-31) - [️ About application](#link-32) - [Architecture](#link-33) - [Los lanzamientos son aproximadamente una vez cada seis meses. Lo siguiente será:](#link-34) @@ -142,7 +144,7 @@ Or open a saved file and manually change the encoding to UTF-8. #### Using website - ir a [sitio web](https://bakhirev.github.io/) -- pulse el botón [Demo](https://bakhirev.github.io/demo?ref=github)» +- pulse el botón [Demo](https://bakhirev.github.io/demo)» - arrastrar y soltar archivo `log.txt` en la ventana del navegador #### Use the library NodeJS @@ -239,12 +241,18 @@ Cada vez que reinicie su computadora, el script actualizará la estadística de ### 🛠️ DevOps (CI/CD) +#### Github Actions +Use Github Actions to automatically create a report within your builds. +- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace; +- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action; +I recommend using the first option. It is more stable and increases the statistics of installations. + #### Servidor público Puede publicar el archivo con los datos para generar el informe en una URL pública. Para visualizarlo, puede usar la interfaz web del sitio [assayo](https://bakhirev.github.io/). Simplemente indique la dirección donde están los datos en el parámetro URL ```dump```: ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### Servidor privado - descargar [docker образ](https://hub.docker.com/r/bakhirev/assayo); - recogerlo en la red local; @@ -255,13 +263,6 @@ assayo_url - URL dirección del contenedor assayo, Él está escuchando el puert you_url - URL la dirección de su contenedor con registros git; ``` Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0.0.1:80/```. Si no funciona, compruebe si tiene el puerto 80 disponible - -#### Actualización de la imagen Docker -- construir ```npm run build:docker``` -- montar la imagen ```docker build -t assayo .``` -- comprobar visualmente la imagen ```docker run --name assayo -p 80:80 -d assayo```; -- poner la etiqueta ```docker tag assayo bakhirev/assayo:latest```; -- poner la imagen en Docker Hub ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ About application diff --git a/documents/FR.md b/documents/FR.md index 377be6d..0af0125 100644 --- a/documents/FR.md +++ b/documents/FR.md @@ -4,11 +4,13 @@ # [Assayo](https://bakhirev.github.io/?ref=github&lang=fr) Visualisation et analyse des données de votre dépôt git. Performance tool for Team Lead and IT-audit + **Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/). + **Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 Un employé peut évaluer un nouveau lieu de travail @@ -58,9 +60,9 @@ Visualisation et analyse des données de votre dépôt git. Performance tool for - [With backend](#link-26) - [Sans back-end](#link-27) - [DevOps ](#link-28) - - [Serveur public](#link-29) - - [Serveur privé](#link-30) - - [Mise à jour de l’image-Docker](#link-31) + - [Github Actions](#link-29) + - [Serveur public](#link-30) + - [Serveur privé](#link-31) - [️ About application](#link-32) - [Architecture](#link-33) - [Les versions sont publiées environ tous les six mois. Quoi de neuf:](#link-34) @@ -142,7 +144,7 @@ Or open a saved file and manually change the encoding to UTF-8. #### Using website - Aller à [сайт](https://bakhirev.github.io/) -- Appuyer sur le bouton “[Démo](https://bakhirev.github.io/demo?ref=github)” +- Appuyer sur le bouton “[Démo](https://bakhirev.github.io/demo)” - Faites glisser le fichier `log.txt` dans la fenêtre du navigateur #### Use the library NodeJS @@ -236,12 +238,18 @@ fi ### 🛠️ DevOps (CI/CD) +#### Github Actions +Use Github Actions to automatically create a report within your builds. +- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace; +- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action; +I recommend using the first option. It is more stable and increases the statistics of installations. + #### Serveur public Vous pouvez mettre à disposition le fichier avec les données pour construire le rapport sur l’URL publique. Et pour sa visualisation, utiliser l’interface web du site. [assayo](https://bakhirev.github.io/). Tout simplement, indiquez l’adresse où se trouvent les données dans le paramètre de l’URL ```dump```: ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### Serveur privé - télécharger [docker образ](https://hub.docker.com/r/bakhirev/assayo); - Soulevez-le sur le réseau local; @@ -252,13 +260,6 @@ assayo_url - URL Conteneur assayo, écoute le port 80; you_url - URL адресс Adresse de votre conteneur de logs git; ``` Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne fonctionne pas, vérifiez si le port 80 est disponible. - -#### Mise à jour de l’image-Docker -- constuire la build ```npm run build:docker``` -- assembler l'image ```docker build -t assayo .``` -- vérifier visuellement l'image ```docker run --name assayo -p 80:80 -d assayo```; -- mettre la balise ```docker tag assayo bakhirev/assayo:latest```; -- Envoyer le code au référentiel d'images dans Docker Hub ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ About application diff --git a/documents/JA.md b/documents/JA.md index 4ddbe55..743f023 100644 --- a/documents/JA.md +++ b/documents/JA.md @@ -4,11 +4,13 @@ # [Assayo](https://bakhirev.github.io/?ref=github&lang=ja) データの可視化とGitレポジトリの分析 + **Links:** [デモ](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/). + **Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 従業員は新しい職場を評価することができます @@ -58,9 +60,9 @@ - [With backend](#link-26) - [バックエンドなし](#link-27) - [DevOps ](#link-28) - - [公開サーバ](#link-29) - - [プライベートサーバー](#link-30) - - [Dockerイメージの更新](#link-31) + - [Github Actions](#link-29) + - [公開サーバ](#link-30) + - [プライベートサーバー](#link-31) - [️ About application](#link-32) - [Architecture](#link-33) - [半年ごとにリリースを行います。次は何でしょうか。](#link-34) @@ -238,12 +240,18 @@ fi ### 🛠️ DevOps (CI/CD) +#### Github Actions +Use Github Actions to automatically create a report within your builds. +- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace; +- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action; +I recommend using the first option. It is more stable and increases the statistics of installations. + #### 公開サーバ データをレポートビルド用に公開するファイルをURLで公開することができます。その視覚化は、サイト上で利用可能なツールを使用することで行うことができます。 [assayo](https://bakhirev.github.io/). データがある場所のアドレスを、URLパラメータに入力してください。 ```dump```: ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### プライベートサーバー - ダウンロード [dockerイメージ](https://hub.docker.com/r/bakhirev/assayo); - ローカルネットワーク内で実行します。; @@ -254,13 +262,6 @@ assayo_url - ポート80でリッスンしているassayoコンテナのURL; you_url - gitのログのコンテナーのURLアドレス; ``` デフォルトではイメージは以下のアドレスで起動します ```http://127.0.0.1:80/```. 問題が解決しない場合は、ポート80が開いているか確認してみてください。 - -#### Dockerイメージの更新 -- 次のコマンドを実行します ```npm run build:docker``` -- 次のコマンドを実行します ```docker build -t assayo .``` -- 結果を確認する ```docker run --name assayo -p 80:80 -d assayo```; -- 次のコマンドを実行します ```docker tag assayo bakhirev/assayo:latest```; -- コンテナイメージをDocker Hubにアップロードする ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ About application diff --git a/documents/PT.md b/documents/PT.md index e40dc75..1fcd5a8 100644 --- a/documents/PT.md +++ b/documents/PT.md @@ -4,11 +4,13 @@ # [Assayo](https://bakhirev.github.io/?ref=github&lang=pt) Visualização e análise de dados do seu repositório git. Performance tool for Team Lead and IT-audit + **Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/). + **Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 Funcionario de avaliar o novo local de trabalho @@ -58,9 +60,9 @@ Visualização e análise de dados do seu repositório git. Performance tool for - [With backend](#link-26) - [Sem backend](#link-27) - [DevOps ](#link-28) - - [Servidor Público](#link-29) - - [Servidor Privado](#link-30) - - [Atualizar a imagem Docker](#link-31) + - [Github Actions](#link-29) + - [Servidor Público](#link-30) + - [Servidor Privado](#link-31) - [️ About application](#link-32) - [Architecture](#link-33) - [Liberações, aproximadamente, uma vez por semestre. O que vem a seguir:](#link-34) @@ -238,12 +240,18 @@ A cada reinício do computador, o script atualiza a estatística com todos os da ### 🛠️ DevOps (CI/CD) +#### Github Actions +Use Github Actions to automatically create a report within your builds. +- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace; +- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action; +I recommend using the first option. It is more stable and increases the statistics of installations. + #### Servidor Público Você pode disponibilizar o arquivo com os dados para construção do relatório em um URL público. Para visualizá-lo, você pode usar um site [assayo](https://bakhirev.github.io/). Especifique o endereço onde os dados estão localizados no parâmetro de URL ```dump```: ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### Servidor Privado - baixar [docker imagem](https://hub.docker.com/r/bakhirev/assayo); - execute-o na rede local; @@ -254,13 +262,6 @@ assayo_url - O URL do endereço do container Assay, ele está escutando na porta you_url - O URL do seu container com os logs do git; ``` Por padrão, a imagem será iniciada no endereço ```http://127.0.0.1:80/```. Se você não conseguiu, verifique se a porta 80 está disponível no seu computador. - -#### Atualizar a imagem Docker -- executar um comando ```npm run build:docker``` -- executar um comando ```docker build -t assayo .``` -- verificar o resultado ```docker run --name assayo -p 80:80 -d assayo```; -- executar um comando ```docker tag assayo bakhirev/assayo:latest```; -- enviar a imagem do container para o Docker Hub ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ About application diff --git a/documents/RU.md b/documents/RU.md index 4d68648..0e3915b 100644 --- a/documents/RU.md +++ b/documents/RU.md @@ -3,11 +3,13 @@ # [Assayo](https://bakhirev.github.io/?ref=github&lang=ru) Визуализация и анализ данных вашего git-репозитория. Инструмент для тимлидов и IT-аудита. + **Ссылки:** [демо](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/). + **Видео:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 Сотрудник может оценить новое место работы @@ -57,9 +59,9 @@ - [С бекендом](#link-26) - [Без бекенда](#link-27) - [DevOps ](#link-28) - - [Публичный сервер](#link-29) - - [Приватный сервер](#link-30) - - [Обновление Docker-образа](#link-31) + - [Github Actions](#link-29) + - [Публичный сервер](#link-30) + - [Приватный сервер](#link-31) - [️ О приложении](#link-32) - [Архитектура](#link-33) - [Релизы, примерно, раз в полгода. Что дальше:](#link-34) @@ -141,7 +143,7 @@ Git создаст файл `log.txt`. Он содержит данные для #### Через сайт - Перейти на [сайт](https://bakhirev.github.io/) -- Нажать кнопку «[Демо](https://bakhirev.github.io/demo?ref=github)» +- Нажать кнопку «[Демо](https://bakhirev.github.io/demo)» - Перетащить файл `log.txt` в окно браузера #### Используя библиотеку NodeJS @@ -237,12 +239,18 @@ fi ### 🛠️ DevOps (CI/CD) +#### Github Actions +Используйте Github Actions для автоматического создания отчёта в рамках ваших сборок. +- [пример](https://github.com/marketplace/actions/assayo) action из официального магазина; +- [пример](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) action собраного руками; +Рекомендуем использовать первый вариант. Он более стабильный и увеличивает нашу статистику установок. + #### Публичный сервер Вы можете выкладывать файл с данными для построения отчёта на публичный URL. А для его визуализации использовать веб-интерфейс сайта [assayo](https://bakhirev.github.io/). Просто укажите адресс, где лежат данные, в URL-параметре ```dump```: ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### Приватный сервер - скачайте [docker образ](https://hub.docker.com/r/bakhirev/assayo); - поднимите его в локальной сети; @@ -253,13 +261,6 @@ assayo_url - URL адресс контейнера assayo, он слушает 8 you_url - URL адресс вашего контейнера с логами git; ``` По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт. - -#### Обновление Docker-образа -- собрать билд ```npm run build:docker``` -- собрать образ ```docker build -t assayo .``` -- визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```; -- поставить тег ```docker tag assayo bakhirev/assayo:latest```; -- запушить образ в Docker Hub ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ О приложении diff --git a/documents/ZH.md b/documents/ZH.md index 017a1d4..13ad698 100644 --- a/documents/ZH.md +++ b/documents/ZH.md @@ -4,11 +4,13 @@ # [Assayo](https://bakhirev.github.io/?ref=github&lang=zh) 对您的git仓库的数据进行可视化和分析 团队领导及资讯科技审核的表现工具 + **Links:** [示范表现](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/). + **Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ). - + ##### 👨‍💻 工作人员可以评估新工作场所 @@ -58,9 +60,9 @@ - [With backend](#link-26) - [没有后端](#link-27) - [DevOps ](#link-28) - - [公共服务器](#link-29) - - [专用服务器](#link-30) - - [Docker 图像更新](#link-31) + - [Github Actions](#link-29) + - [公共服务器](#link-30) + - [专用服务器](#link-31) - [️ About application](#link-32) - [Architecture](#link-33) - [释出版本大约每半年一次。接下来发生什么情况：](#link-34) @@ -238,12 +240,18 @@ fi ### 🛠️ DevOps (CI/CD) +#### Github Actions +Use Github Actions to automatically create a report within your builds. +- [example](https://github.com/marketplace/actions/assayo) action from the official marketplace; +- [example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action; +I recommend using the first option. It is more stable and increases the statistics of installations. + #### 公共服务器 您可以将数据构建报告文件发布到公共URL，可以使用网站来显示它。 [assayo](https://bakhirev.github.io/). 指定数据所在的地址作为URL参数 ```dump```: ``` https://bakhirev.github.io/demo/?dump=//you_site.com/some/log.txt ``` - + #### 专用服务器 - 下载 [docker镜像](https://hub.docker.com/r/bakhirev/assayo); - 在本地网络中运行它; @@ -254,13 +262,6 @@ assayo_url - assayo容器的URL地址，它监听80端口; you_url - git日志的容器的URL地址; ``` 默认情况下，镜像会被启动在地址 ```http://127.0.0.1:80/```. 如果没有成功，请检查你的80端口是否可用. - -#### Docker 图像更新 -- 运行命令 ```npm run build:docker``` -- 运行命令 ```docker build -t assayo .``` -- 检查结果 ```docker run --name assayo -p 80:80 -d assayo```; -- 运行命令 ```docker tag assayo bakhirev/assayo:latest```; -- 提交容器映像到 Docker Hub ```docker push bakhirev/assayo:latest```; ### 🛠️ ️ About application diff --git a/documents/src/json/de.json b/documents/src/json/de.json index 05d0642..3e899fa 100644 --- a/documents/src/json/de.json +++ b/documents/src/json/de.json @@ -3,7 +3,7 @@ "p": "Visualisierung und analyse ihrer git-datenbank. Performance tool for Team Lead and IT-audit" }, { - "p": "**Links:** [demo](https://bakhirev.github.io/demo/?dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." + "p": "**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." }, { "p": "**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ)." @@ -365,6 +365,21 @@ { "h3": "DevOps (CI/CD)" }, + { + "h4": "Github Actions" + }, + { + "p": "Use Github Actions to automatically create a report within your builds." + }, + { + "li": [ + "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;", + "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;" + ] + }, + { + "p": "I recommend using the first option. It is more stable and increases the statistics of installations." + }, { "h4": "Öffentlicher server" }, @@ -396,18 +411,6 @@ { "p": "Standardmäßig wird das abbild an der folgenden adresse ausgeführt ```http://127.0.0.1:80/```. Wenn es nicht funktioniert, überprüfen sie, ob der port 80 frei ist." }, - { - "h4": "Aktualisieren eines Docker-Images" - }, - { - "li": [ - "befehl ausführen ```npm run build:docker```", - "befehl ausführen ```docker build -t assayo .```", - "ergebnis überprüfen ```docker run --name assayo -p 80:80 -d assayo```;", - "befehl ausführen ```docker tag assayo bakhirev/assayo:latest```;", - "senden sie ein containerimage an Docker Hub ```docker push bakhirev/assayo:latest```;" - ] - }, { "h3": "️ About application" }, diff --git a/documents/src/json/en.json b/documents/src/json/en.json index da8f1a6..7a918b9 100644 --- a/documents/src/json/en.json +++ b/documents/src/json/en.json @@ -6,7 +6,7 @@ "p": "Visualization and analysis of git commit statistics. Performance tool for Team Lead and IT-audit" }, { - "p": "**Links:** [demo](https://bakhirev.github.io/demo/?dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." + "p": "**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." }, { "p": "**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ)." @@ -368,6 +368,21 @@ { "h3": "DevOps (CI/CD)" }, + { + "h4": "Github Actions" + }, + { + "p": "Use Github Actions to automatically create a report within your builds." + }, + { + "li": [ + "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;", + "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;" + ] + }, + { + "p": "I recommend using the first option. It is more stable and increases the statistics of installations." + }, { "h4": "Public server" }, @@ -399,18 +414,6 @@ { "p": "By default, the image will run at ```http://127.0.0.1:80/```. If it doesn't work, check if port 80 is free." }, - { - "h4": "How to update the Docker image?" - }, - { - "li": [ - "run ```npm run build:docker```", - "run ```docker build -t assayo .```", - "visually check the image ```docker run --name assayo -p 80:80 -d assayo```;", - "add tag ```docker tag assayo bakhirev/assayo:latest```;", - "push image to [Docker Hub](https://hub.docker.com/r/bakhirev/assayo) ```docker push bakhirev/assayo:latest```;" - ] - }, { "h3": "️ About application" }, diff --git a/documents/src/json/es.json b/documents/src/json/es.json index 0470ac7..53808ed 100644 --- a/documents/src/json/es.json +++ b/documents/src/json/es.json @@ -6,7 +6,7 @@ "p": "Visualización y análisis de los datos de su repositorio git. Performance tool for Team Lead and IT-audit" }, { - "p": "**Links:** [demo](https://bakhirev.github.io/demo/?dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." + "p": "**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." }, { "p": "**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ)." @@ -371,6 +371,21 @@ { "h3": "DevOps (CI/CD)" }, + { + "h4": "Github Actions" + }, + { + "p": "Use Github Actions to automatically create a report within your builds." + }, + { + "li": [ + "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;", + "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;" + ] + }, + { + "p": "I recommend using the first option. It is more stable and increases the statistics of installations." + }, { "h4": "Servidor público" }, @@ -402,18 +417,6 @@ { "p": "Por defecto, la imagen se ejecutará en la siguiente dirección ```http://127.0.0.1:80/```. Si no funciona, compruebe si tiene el puerto 80 disponible" }, - { - "h4": "Actualización de la imagen Docker" - }, - { - "li": [ - "construir ```npm run build:docker```", - "montar la imagen ```docker build -t assayo .```", - "comprobar visualmente la imagen ```docker run --name assayo -p 80:80 -d assayo```;", - "poner la etiqueta ```docker tag assayo bakhirev/assayo:latest```;", - "poner la imagen en Docker Hub ```docker push bakhirev/assayo:latest```;" - ] - }, { "h3": "️ About application" }, diff --git a/documents/src/json/fr.json b/documents/src/json/fr.json index abed368..c12ff37 100644 --- a/documents/src/json/fr.json +++ b/documents/src/json/fr.json @@ -6,7 +6,7 @@ "p": "Visualisation et analyse des données de votre dépôt git. Performance tool for Team Lead and IT-audit" }, { - "p": "**Links:** [demo](https://bakhirev.github.io/demo/?dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." + "p": "**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." }, { "p": "**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ)." @@ -362,6 +362,21 @@ { "h3": "DevOps (CI/CD)" }, + { + "h4": "Github Actions" + }, + { + "p": "Use Github Actions to automatically create a report within your builds." + }, + { + "li": [ + "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;", + "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;" + ] + }, + { + "p": "I recommend using the first option. It is more stable and increases the statistics of installations." + }, { "h4": "Serveur public" }, @@ -393,18 +408,6 @@ { "p": "Par défaut, l'image s'exécute à ```http://127.0.0.1:80/```. Si cela ne fonctionne pas, vérifiez si le port 80 est disponible." }, - { - "h4": "Mise à jour de l’image-Docker" - }, - { - "li": [ - "constuire la build ```npm run build:docker```", - "assembler l'image ```docker build -t assayo .```", - "vérifier visuellement l'image ```docker run --name assayo -p 80:80 -d assayo```;", - "mettre la balise ```docker tag assayo bakhirev/assayo:latest```;", - "Envoyer le code au référentiel d'images dans Docker Hub ```docker push bakhirev/assayo:latest```;" - ] - }, { "h3": "️ About application" }, diff --git a/documents/src/json/ja.json b/documents/src/json/ja.json index 22fc06b..ae2fe12 100644 --- a/documents/src/json/ja.json +++ b/documents/src/json/ja.json @@ -6,7 +6,7 @@ "p": "データの可視化とGitレポジトリの分析" }, { - "p": "**Links:** [デモ](https://bakhirev.github.io/demo/?dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." + "p": "**Links:** [デモ](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." }, { "p": "**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ)." @@ -368,6 +368,21 @@ { "h3": "DevOps (CI/CD)" }, + { + "h4": "Github Actions" + }, + { + "p": "Use Github Actions to automatically create a report within your builds." + }, + { + "li": [ + "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;", + "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;" + ] + }, + { + "p": "I recommend using the first option. It is more stable and increases the statistics of installations." + }, { "h4": "公開サーバ" }, @@ -399,18 +414,6 @@ { "p": "デフォルトではイメージは以下のアドレスで起動します ```http://127.0.0.1:80/```. 問題が解決しない場合は、ポート80が開いているか確認してみてください。" }, - { - "h4": "Dockerイメージの更新" - }, - { - "li": [ - "次のコマンドを実行します ```npm run build:docker```", - "次のコマンドを実行します ```docker build -t assayo .```", - "結果を確認する ```docker run --name assayo -p 80:80 -d assayo```;", - "次のコマンドを実行します ```docker tag assayo bakhirev/assayo:latest```;", - "コンテナイメージをDocker Hubにアップロードする ```docker push bakhirev/assayo:latest```;" - ] - }, { "h3": "️ About application" }, diff --git a/documents/src/json/pt.json b/documents/src/json/pt.json index f7570b0..228412b 100644 --- a/documents/src/json/pt.json +++ b/documents/src/json/pt.json @@ -6,7 +6,7 @@ "p": "Visualização e análise de dados do seu repositório git. Performance tool for Team Lead and IT-audit" }, { - "p": "**Links:** [demo](https://bakhirev.github.io/demo/?dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." + "p": "**Links:** [demo](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." }, { "p": "**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ)." @@ -368,6 +368,21 @@ { "h3": "DevOps (CI/CD)" }, + { + "h4": "Github Actions" + }, + { + "p": "Use Github Actions to automatically create a report within your builds." + }, + { + "li": [ + "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;", + "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;" + ] + }, + { + "p": "I recommend using the first option. It is more stable and increases the statistics of installations." + }, { "h4": "Servidor Público" }, @@ -399,18 +414,6 @@ { "p": "Por padrão, a imagem será iniciada no endereço ```http://127.0.0.1:80/```. Se você não conseguiu, verifique se a porta 80 está disponível no seu computador." }, - { - "h4": "Atualizar a imagem Docker" - }, - { - "li": [ - "executar um comando ```npm run build:docker```", - "executar um comando ```docker build -t assayo .```", - "verificar o resultado ```docker run --name assayo -p 80:80 -d assayo```;", - "executar um comando ```docker tag assayo bakhirev/assayo:latest```;", - "enviar a imagem do container para o Docker Hub ```docker push bakhirev/assayo:latest```;" - ] - }, { "h3": "️ About application" }, diff --git a/documents/src/json/ru.json b/documents/src/json/ru.json index a773b7a..44c7645 100644 --- a/documents/src/json/ru.json +++ b/documents/src/json/ru.json @@ -3,7 +3,7 @@ "p": "Визуализация и анализ данных вашего git-репозитория. Инструмент для тимлидов и IT-аудита." }, { - "p": "**Ссылки:** [демо](https://bakhirev.github.io/demo/?dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." + "p": "**Ссылки:** [демо](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." }, { "p": "**Видео:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ)." @@ -366,6 +366,21 @@ { "h3": "DevOps (CI/CD)" }, + { + "h4": "Github Actions" + }, + { + "p": "Используйте Github Actions для автоматического создания отчёта в рамках ваших сборок." + }, + { + "li": [ + "[пример](https://github.com/marketplace/actions/assayo) action из официального магазина;", + "[пример](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) action собраного руками;" + ] + }, + { + "p": "Рекомендуем использовать первый вариант. Он более стабильный и увеличивает нашу статистику установок." + }, { "h4": "Публичный сервер" }, @@ -397,18 +412,6 @@ { "p": "По умолчанию образ запустится по адресу ```http://127.0.0.1:80/```. Если не получилось проверьте свободен ли у вас 80 порт." }, - { - "h4": "Обновление Docker-образа" - }, - { - "li": [ - "собрать билд ```npm run build:docker```", - "собрать образ ```docker build -t assayo .```", - "визуально проверить образ ```docker run --name assayo -p 80:80 -d assayo```;", - "поставить тег ```docker tag assayo bakhirev/assayo:latest```;", - "запушить образ в Docker Hub ```docker push bakhirev/assayo:latest```;" - ] - }, { "h3": "️ О приложении" }, diff --git a/documents/src/json/zh.json b/documents/src/json/zh.json index 46201ff..b795c7f 100644 --- a/documents/src/json/zh.json +++ b/documents/src/json/zh.json @@ -6,7 +6,7 @@ "p": "对您的git仓库的数据进行可视化和分析 团队领导及资讯科技审核的表现工具" }, { - "p": "**Links:** [示范表现](https://bakhirev.github.io/demo/?dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." + "p": "**Links:** [示范表现](https://bakhirev.github.io/demo/?ref=github&dump=./test.txt), [online version](https://bakhirev.github.io/demo/?ref=github), [docker](https://hub.docker.com/r/bakhirev/assayo), [reddit](https://www.reddit.com/r/ITManagers/comments/1e5k291/the_visualization_and_analysis_of_git_commit/), [habr](https://habr.com/ru/articles/852782/)." }, { "p": "**Video:** [english](https://www.youtube.com/watch?v=uMbhrrd25t4), [español](https://www.youtube.com/watch?v=skmctb_2rZ0), [русский](https://www.youtube.com/watch?v=jwCp_-bhrCQ)." @@ -368,6 +368,21 @@ { "h3": "DevOps (CI/CD)" }, + { + "h4": "Github Actions" + }, + { + "p": "Use Github Actions to automatically create a report within your builds." + }, + { + "li": [ + "[example](https://github.com/marketplace/actions/assayo) action from the official marketplace;", + "[example](https://github.com/bakhirev/assayo/blob/main/documents/ActionExample.yml) custom action;" + ] + }, + { + "p": "I recommend using the first option. It is more stable and increases the statistics of installations." + }, { "h4": "公共服务器" }, @@ -399,18 +414,6 @@ { "p": "默认情况下，镜像会被启动在地址 ```http://127.0.0.1:80/```. 如果没有成功，请检查你的80端口是否可用." }, - { - "h4": "Docker 图像更新" - }, - { - "li": [ - "运行命令 ```npm run build:docker```", - "运行命令 ```docker build -t assayo .```", - "检查结果 ```docker run --name assayo -p 80:80 -d assayo```;", - "运行命令 ```docker tag assayo bakhirev/assayo:latest```;", - "提交容器映像到 Docker Hub ```docker push bakhirev/assayo:latest```;" - ] - }, { "h3": "️ About application" },