Опит с използването на flatten-maven-plugin за опростяване на версиите в maven проекти

За нас

В 1C ние разработваме не само платформа 1C: Предприятие на C ++ и JavaScript, но също и Java приложения - по-специално новата среда за разработка Инструменти за развитие на предприятието базиран на Eclipse и месинджър сървър, дълбоко интегриран с платформата - Системи за взаимодействие.

Влизане

Най-често използваме maven като система за изграждане на Java приложения и в тази кратка статия бихме искали да говорим за един от проблемите, с които трябваше да се сблъскаме в процеса на организиране на разработката, и за подхода, който ни позволи да преодолеем това проблем.

Предпоставки и работен процес

Поради спецификата на разработката в нашите maven проекти, ние използваме доста модули, зависимости и дъщерни проекти. Броят на pom файловете в едно дърво може да бъде десетки или дори стотици.

Изглежда: нищо страшно, те са го създали веднъж и са го забравили. Ако трябва да промените или добавите нещо във всички файлове наведнъж, има много удобни инструменти в редакторите и IDE. Коя е най-честата редовна промяна на pom.xml? Вярваме, че промените във версиите на проекта и зависимостите. Може би някой ще иска да спори с това, но при нас е точно това. Причината се крие във факта, че заедно с ядрото ние едновременно разработваме много от нашите собствени библиотеки и за постоянната възпроизводимост на резултатите от изграждането и тестването използването на моментни снимки не ни се струва удобен подход. Поради тази причина е необходимо да се повишава номерът на версията в проектите с всяка компилация.

Също така, от време на време разработчикът трябва да изгради свой собствен клон на библиотека и да провери функционалността му спрямо всички зависимости, за което той трябва ръчно да промени версията на всички тях.

Първоначално решение

С такива чести и множество промени на версиите искам да опростя и автоматизирам процеса в CI. Тук на помощ идва удобен, добре познат плъгин. версии-maven-плъгин - свържете го и го стартирайте

mvn -N версии: set -DnewVersion=2.0.1

и Maven ще направи всичко както трябва: ще премине през йерархията отгоре надолу, заменяйки всички версии - красота! Сега всичко, което остава, е да повдигнете заявка за изтегляне, колегите ще прегледат промените и можете бързо да се присъедините към багажника. бързо? Без значение как е. Няколко стотин pom.xml за преглед и това не включва кода. Освен това никой не е застрахован от конфликти при сливане с толкова голям брой променени файлове. Тук трябва да се отбележи, че в процеса на CI промените във версията се случват автоматично заедно с промените във функционалността, а не по някакъв начин отделно.

Нови функции

За известно време се успокоихме и като се примирихме, заживяхме така, докато момчетата от Проект Maven Apache Започвайки от версия 3.5.0-beta-1, Maven не включва поддръжка за така наречените „заместители“. Същността на тези заместители е, че pom.xml вместо конкретна индикация за версията на проекта се използват променливи ${ревизия}, ${sha1} и ${changelist}. Самите стойности на тези свойства се задават или в елементасвойства> или могат да бъдат дефинирани чрез системно свойство

mvn -Drevision=2.0.0 чист пакет

Стойностите на системните свойства имат предимство пред стойностите, дефинирани всвойства>.

родител

  4.0.0
  
    org.apache
    апаш
    18
  
  org.apache.maven.ci
  ci-родител
  Първо CI Friendly
  ${revision}${sha1}${changelist}
  ...
  
    1.3.1
    -МОМЕНТАЛНА СНИМКА
    
  


Потомък

  4.0.0
  
    org.apache.maven.ci
    ci-родител
    ${revision}${sha1}${changelist}
  
  org.apache.maven.ci
  ci-дете
   ...

Ако искате да изградите версия 2.0.0-SNAPSHOT, просто използвайте

    mvn -Drevision=2.0.0 чист пакет

Ако искате да направите съобщение, просто нулирайте SNAPSHOT

    mvn -Dchangelist= чист пакет

*Примерите по-горе са взети от статии на уебсайта на проекта Maven Apache

Сурова реалност

Всичко е добро и здравословно, време е да изпитате чувство на удовлетворение, но не. Оказва се, че този метод няма да работи за инсталиране и внедряване, тъй като няма да бъде заменен в описанията на артефактите, публикувани в хранилището ${ревизия} върху значението му и maven вече няма да разбира за какво става дума.

    org.apache
    апаш
    ${ревизия}

Светлина в края на тунел

Трябва да търсим решение на проблема. Можеше да спаси положението flatten-maven-плъгин. Този плъгин разрешава всички променливи в pom, но в същото време изрязва много друга информация, която е необходима само по време на асемблирането и не е необходима при импортиране на публикувани артефакти в други проекти. Плъгинът също „изправя“ всички зависимости родител-дете и в резултат на това получавате плосък pom, който включва всичко, от което се нуждаете. Неудобството беше, че изрязва твърде много „допълнително“, което изобщо не ни устройваше. След като проучихме информацията за разработването на този плъгин, се оказа, че ние не сме единствените във вселената и през август 2018 г. беше създадена заявка за изтегляне в Github в хранилището на плъгините с желанието да го направи възможно да определим сами как да „развалим“ pom.xml. Разработчиците се вслушаха в гласовете на страдащите и още през декември, с пускането на новата версия 1.1.0, в плъгина flatten-maven-plugin се появи нов режим, resolveCiFriendliesOnly, който беше по-подходящ от всякога - оставя pom.xml такъв, какъвто е, с изключение на елемента и позволява ${ревизия}, ${sha1} и ${changelist}.

Добавяне на плъгин към проекта

  
    org.codehaus.mojo
    flatten-maven-plugin
    1.1.0
    
      вярно
      resolveCiFriendliesOnly
    
    
      
        изравнявам
        процес-ресурси
        
          изравнявам
        
      
      
        изравнявам.почиствам
        чиста
        
          чиста
        
      
    
  

Готово!

Щастлив край

Отсега нататък, за да променим версията на целия проект и да уведомим всички зависимости за него, трябва само да редактираме елементаревизия> само в корена pom.xml. На прегледа пристигат не сто или два от тези файлове с една и съща промяна, а един. Е, няма нужда да се използва версии-maven-плъгин.

Източник: www.habr.com