reprort - Gregory Shchelokaev by GRIGAeo · Pull Request #18 · gsvgit/1_year_practice_2026_reports

GRIGAeo · 2026-06-11T16:05:17Z

Add report. Проект UCFS: Доработка репозитория

gsvgit · 2026-06-12T05:11:31Z

+
+% Буквально парой предложений ввести в контекст, обязательно сформулировать цель работы. Если работа делается где-то глубоко внутри проекта, на введение можно потратить больше места, чтобы подвести читателя от сути проекта в целом к тому, что конкретно вам надо было сделать. Только без воды, никакого "в современном мире"!
+% Работа выполняется в компании \dots в рамках проекта по \dots. \textbf{Целью работы является} \dots
+Работа выполняется в рамках проекта UCFS\footnote{Ссылка на UCFS: \url{https://github.com/FormalLanguageConstrainedPathQuerying/UCFS}}. UCFS "--- это инструмент для решения задач анализа графов с дополнительными ограничениями на пути, заданными контекстно-свободной грамматикой какого-либо языка. Целью работы является обеспечение проекта соответствующей инфраструктурой (CI, публикация пакетов, контроль тестового покрытия).


UCFS "--- --- странная конструкция. Если Вы про неразрывный пробел, то это UCFS~---

gsvgit · 2026-06-12T05:12:28Z

+% Это пояснение актуальности. Тут обязательно надо обрисовать полезность вашей работы для конечного пользователя (и заодно как-то описать, кто такой ваш конечный пользователь --- может, это соседняя команда). Даже если вы делаете работу "глубоко внутри", выясните у консультанта, чем это людям поможет. И опишите, кто выступал в роли "заказчика" вашей работы, т.е. кто и зачем предложил задачу. Можно без конкретных имён, но названия организаций вполне желательны.
+% Результаты работы необходимы для \dots, для конечных пользователей продукта это полезно тем-то, в выполнении работы заинтересованы те-то.
+
+Результаты работы необходимы для снижения временных издержек разработчиков проекта на регулярное слияние кода, ручного запуска тестов, публикации jar-файлов, а также минимизации рисков при помощи контроля тестового покрытия. Для конечных пользователей продукта это полезно снижением рисков обнаружения некорректной работы программы. В выполнении работы в первую очередь заинтересованы разработчики данной реализации инструмента.


разработчики данной реализации инструмента --- наверное, просто разработчики данного инструмента

gsvgit · 2026-06-12T05:13:28Z

+% Раздел пишется в свободной форме, с минимумом технических подробностей (можно приводить ссылки на более подробные документы).
+
+% Тут надо кратко описать идею решения, спозиционировать его относительно предыдущих наработок\footnote{Если на них надо сослаться, то в подстраничной сноске, URL: \url{http://example.com} (дата обращения: не забываем указывать).} и существующих аналогов (тоже предельно кратко), по возможности обосновать принятые решения.
+Основной идеей решения поставленных задач является создание соответствующих конфигурационных файлов (настройка CI/CD), изменение существующих файлов сборки отдельных модулей проекта для создания корректных отчётов о тестовом покрытии, добавление отдельного модуля, отвечающего за публикацию jar-файлов на GitHub Packages.


Это не идея, просто решение уже. Пишите проще и конкретнее.

gsvgit · 2026-06-12T05:14:20Z

+Основной идеей решения поставленных задач является создание соответствующих конфигурационных файлов (настройка CI/CD), изменение существующих файлов сборки отдельных модулей проекта для создания корректных отчётов о тестовом покрытии, добавление отдельного модуля, отвечающего за публикацию jar-файлов на GitHub Packages.
+% Вот это важно, опишите кратко, что использовали
+
+Для выполнения поставленных задач код соответствующих программ был написан на языке программирования Kotlin Script и языке сериализации данных YAML.


Каких программ? Выше у Вас только про конфиги, практически. Аккуратнее. Может даже подробнее.

gsvgit · 2026-06-12T05:15:15Z

+
+Контроль тестового покрытия:
+\begin{itemize}
+    \item ./gradlew solver:jacocoTestCoverageVerification generator:jacocoTestCoverageVerification -- BUILD SUCCESSFUL


Это что за заклинание? Текст должен быть текстом. Хоть и с техническими подробностями.

Тут, кстати, тоже с тире беда.

gsvgit · 2026-06-12T05:15:52Z

+Контроль тестового покрытия:
+\begin{itemize}
+    \item ./gradlew solver:jacocoTestCoverageVerification generator:jacocoTestCoverageVerification -- BUILD SUCCESSFUL
+    \item прогон воркфлоу через act pull\_request -- Job succeeded, все 5 шагов выполнены, включая сводную таблицу покрытия


"прогон воркфлоу" --- попахивает разговорной речью. Не надо так в отчётах.

gsvgit · 2026-06-12T05:16:23Z

+
+Публикация jar-файлов:
+\begin{itemize}
+    \item ./gradlew :publisher:publishToMavenLocal -- jar содержит 125 классов solver+generator, POM -- 6 ссылок на внешние зависимости проекта


Тоже пачка каких-то заклинаний. Ещё и тире не совсем правильные.

gsvgit · 2026-06-12T05:17:19Z

+    \item ./gradlew :publisher:publish --dry-run -- BUILD SUCCESSFUL
+\end{itemize}
+
+Воспроизведение:


Воспроизведение чего?

gsvgit · 2026-06-12T05:17:54Z

+    \item \texttt{./bin/act release -W .github/workflows/ci-publishing-jar-files.yaml} --- эмулирует CI-воркфлоу публикации в Docker-контейнере
+\end{itemize}
+
+Вывод: все компоненты CI/CD корректно настроены и проверены -- тесты запускаются, покрытие контролируется, публикация в GitHub Packages работает.


А что мешает провреить прям на гитхаб, пусть и в своём форке?

тире.

gsvgit · 2026-06-12T05:19:23Z

+% ниже списком перечисляете то, что выносится как результат практики.
+
+\begin{itemize}
+    \item Для модуля solver характерны такие показатели тестового покрытия:


Таблицы, рисунки и всякое такое интегрируюбся через ссылку. У таблицы \label, в тексте "что-то там происходит в таблице~\ref{...}"

gsvgit

Почитайте, пожалуйста, прдложенные вам всем материалы по оформлению и вёрстке. Ну или у коллег спросите про типичные ошибки.

WoWaster · 2026-06-14T15:25:19Z

Очень советую всё-таки научиться решать конфликты. Идея: удалить - слить - вернуть — ооочень плохая и за такое на работе Вам дадут по рукам.

gsvgit · 2026-06-15T06:50:25Z

Очень советую всё-таки научиться решать конфликты. Идея: удалить - слить - вернуть — ооочень плохая и за такое на работе Вам дадут по рукам.

Мне что-то подсказывает, что у большинства проблемы с линейностью истории (да, я включил это требование). А тут как бы надо немного больше повозиться, чтобы привести существующую историю в порядок.

Но да, этому стоит научиться.

gsvgit · 2026-06-15T06:51:04Z

+
+\section{Постановка задачи}
+
+% Буквально парой предложений ввести в контекст, обязательно сформулировать цель работы. Если работа делается где-то глубоко внутри проекта, на введение можно потратить больше места, чтобы подвести читателя от сути проекта в целом к тому, что конкретно вам надо было сделать. Только без воды, никакого "в современном мире"!


А зачем тут эти комментирии?

gsvgit · 2026-06-15T06:51:30Z

+Для выполнения поставленных задач соответствующие части данного проекта были написаны на языке программирования Kotlin Script и языке сериализации данных YAML.
+Реализация решения осуществлялась с использованием таких программных продуктов, как платформа непрерывной интеграции GitHub Actions, система сборки проектов Gradle, инструмент контроля тестового покрытия JaCoCo (Java Code Coverage).
+
+\section{Апробация}


Это вряд ли можно назвать апробацией.

Хорошо. Тогда как вы смотрите на то, чтобы в моём отчёте переименовать данный раздел на "Верификация". В шаблоне были только "Апробация" и "Эксперименты", ни тем ни другим проделанная работа не является, поэтому я пришёл к выводу, что стоит дать этому разделу другоме название.

gsvgit · 2026-06-15T06:51:39Z

+
+Проверка выполненных настроек CI/CD, а также контроля тестового покрытия и публикации пакетов проводилась локально и на GitHub Actions в форке~--- \url{https://github.com/GRIGAeo/UCFS} (дата обращения: \DTMdate{2026-06-14}).
+
+Для проверки корректности контроля тестового покрытия из корня проекта были запущены следующие команды:


Точка.

gsvgit · 2026-06-15T06:51:52Z

+    \item ./gradlew :publisher:publishToMavenLocal~--- в результате получается jar-файл, содержащий все скомпилированные файлы исходного кода без внешних библиотек, и POM-файл с указанием ссылок на все 6 зависимостей проекта.
+\end{itemize}
+
+Для проверки корректности публикации пакетов в очередной раз использовалась платформа GitHub Actions в данном форке \url{https://github.com/GRIGAeo/UCFS} (дата обращения: \DTMdate{2026-06-14}). Далее будут представлены варианты завершения workflow \foreignquote{english}{Publish package to GitHub Packages}, который запускается только при выходе новых версий проекта:


Точка.

gsvgit · 2026-06-15T06:52:30Z

+\centering
+\begin{tabular}{|l|c|c|}
+\hline
+Показатель & Покрытие & Порог \\


Исходя из чего попроги устанавливались?

gsvgit · 2026-06-15T13:44:19Z

+Для выполнения поставленных задач соответствующие части данного проекта были написаны на языке программирования Kotlin Script и языке сериализации данных YAML.
+Реализация решения осуществлялась с использованием таких программных продуктов, как платформа непрерывной интеграции GitHub Actions, система сборки проектов Gradle, инструмент контроля тестового покрытия JaCoCo (Java Code Coverage).
+
+\section{Верификация}


Скорее, эксперименты?

…ates

gsvgit requested changes Jun 12, 2026

View reviewed changes

gsvgit requested changes Jun 13, 2026

View reviewed changes

gsvgit requested changes Jun 15, 2026

View reviewed changes

GRIGAeo force-pushed the main branch 2 times, most recently from 7d169a1 to 4cab886 Compare June 15, 2026 13:10

gsvgit reviewed Jun 15, 2026

View reviewed changes

griga311 added 11 commits July 29, 2026 17:12

reprort - Gregory Shchelokaev

1b2e086

for GH Actions

a6ca8b3

for GH Actions again

5685113

fix: address inaccuracies based on relevant remarks in the report

1663c1f

fix: adjust file styling

ce06183

feat: add access dates to URLs, rewrite section 2

50b17cc

add points, delete comments

e09486c

Fix minor wording inaccuracy

8ac447c

fix: correct inaccuracies in section 3 of the report

6fc2cfa

Change verification on experiments

6639628

docs: update report to reflect work changes and refresh link access d…

f86cae2

…ates

GRIGAeo force-pushed the main branch from efa8f1e to f86cae2 Compare July 29, 2026 14:21


		\section{Постановка задачи}

		% Буквально парой предложений ввести в контекст, обязательно сформулировать цель работы. Если работа делается где-то глубоко внутри проекта, на введение можно потратить больше места, чтобы подвести читателя от сути проекта в целом к тому, что конкретно вам надо было сделать. Только без воды, никакого "в современном мире"!


		Проверка выполненных настроек CI/CD, а также контроля тестового покрытия и публикации пакетов проводилась локально и на GitHub Actions в форке~--- \url{https://github.com/GRIGAeo/UCFS} (дата обращения: \DTMdate{2026-06-14}).

		Для проверки корректности контроля тестового покрытия из корня проекта были запущены следующие команды:

Conversation

GRIGAeo commented Jun 11, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gsvgit left a comment

Choose a reason for hiding this comment

Uh oh!

WoWaster commented Jun 14, 2026

Uh oh!

gsvgit commented Jun 15, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants