🥇تجربه در استفاده از پلاگین flatten-maven برای ساده سازی نسخه در پروژه های maven

درباره ما

در 1C ما نه تنها یک پلت فرم را توسعه می دهیم 1C: سازمانی بر C ++ и جاوا اسکریپت، بلکه برنامه های جاوا - به ویژه محیط توسعه جدید ابزارهای توسعه سازمانی بر اساس Eclipse و یک سرور پیام رسان عمیقاً یکپارچه با پلتفرم - سیستم های تعاملی.

ورود

ما اغلب از maven به عنوان یک سیستم ساخت برای برنامه های جاوا استفاده می کنیم و در این مقاله کوتاه می خواهیم در مورد یکی از مشکلاتی که در فرآیند سازماندهی توسعه با آن مواجه بودیم و رویکردی که به ما اجازه می دهد بر این مشکل غلبه کنیم صحبت کنیم. مسئله.

پیش نیازها و گردش کار

با توجه به ویژگی‌های توسعه در پروژه‌های ماون، ما از ماژول‌ها، وابستگی‌ها و پروژه‌های فرزند زیادی استفاده می‌کنیم. تعداد فایل های pom در یک درخت می تواند ده ها یا حتی صدها باشد.

به نظر می رسد: چیز مهمی نیست، آنها یک بار آن را ایجاد کردند و آن را فراموش کردند. اگر نیاز به تغییر یا اضافه کردن چیزی در همه فایل ها به طور همزمان دارید، ابزارهای مناسب زیادی در ویرایشگرها و IDE ها وجود دارد. رایج ترین تغییر منظم به pom.xml چیست؟ ما معتقدیم که تغییرات در نسخه های پروژه و وابستگی ها. شاید کسی بخواهد با این بحث کند، اما این دقیقاً وضعیت در مورد ماست. دلیل آن در این واقعیت نهفته است که، همراه با هسته، به طور همزمان بسیاری از کتابخانه‌های خود را توسعه می‌دهیم، و برای تکرارپذیری مداوم نتایج ساخت و آزمایش، استفاده از عکس‌های فوری به نظر ما رویکرد مناسبی نیست. به همین دلیل لازم است با هر بیلد شماره نسخه را در پروژه ها افزایش دهید.

همچنین، هر از چند گاهی، یک توسعه‌دهنده نیاز دارد تا شاخه‌ای از کتابخانه خود را بسازد و عملکرد آن را در برابر همه وابستگی‌ها بررسی کند، که برای این کار باید نسخه همه آنها را به صورت دستی تغییر دهد.

راه حل اولیه

با چنین تغییرات مکرر و متعدد نسخه، من می خواهم فرآیند را در CI ساده و خودکار کنم. اینجاست که یک پلاگین راحت و شناخته شده به کمک می آید. نسخه-maven-پلاگین - آن را وصل کرده و راه اندازی کنید

mvn -N versions:set -DnewVersion=2.0.1

و Maven همه چیز را همانطور که باید انجام می دهد: از طریق سلسله مراتب از بالا به پایین اجرا می شود و همه نسخه ها را جایگزین می کند - زیبایی! اکنون تنها چیزی که باقی مانده است این است که یک درخواست کشش مطرح کنید، همکاران تغییرات را بررسی خواهند کرد و شما می توانید به سرعت به صندوق عقب بپیوندید. به سرعت؟ مهم نیست چگونه باشد. یکی دو صد pom.xml برای بررسی، و این کد به حساب نمی آید. علاوه بر این، هیچ کس از تداخل ادغام با این تعداد فایل تغییر یافته در امان نیست. در اینجا لازم به ذکر است که در فرآیند CI، تغییرات نسخه به طور خودکار همراه با تغییرات در عملکرد رخ می دهد و نه به نحوی جداگانه.

ویژگی های جدید

مدتی آرام شدیم و با استعفای خودمان، تا زمانی که بچه ها از آنجا بودند، همینطور زندگی کردیم پروژه Maven Apache با شروع از نسخه 3.5.0-beta-1، Maven پشتیبانی از به اصطلاح "placeholders" را شامل نمی شود. ماهیت این جایگزین ها این است که pom.xml به جای یک نشانه خاص از نسخه پروژه، از متغیرها استفاده می شود ${بازبینی}, ${sha1} и ${changelist}. مقادیر خود این ویژگی ها یا در عنصر تنظیم می شونداملاک>، یا می توان آنها را از طریق ویژگی سیستم تعریف کرد

بسته تمیز mvn -Drevision=2.0.0

مقادیر ویژگی های سیستم بر مقادیر تعریف شده در اولویت هستنداملاک>.

والدین

  4.0.0

    org.apache
    آپاچی
    18

  org.apache.maven.ci
  ci-parent
  اولین CI Friendly
  ${revision}${sha1}${changelist}
  ...

    1.3.1
    -عکس فوری



نسل

  4.0.0

    org.apache.maven.ci
    ci-parent
    ${revision}${sha1}${changelist}

  org.apache.maven.ci
  سی-کودک
   ...

اگر می خواهید نسخه 2.0.0-SNAPSHOT را بسازید، فقط از آن استفاده کنید

بسته تمیز mvn -Drevision=2.0.0

اگر می‌خواهید یک نسخه منتشر کنید، فقط SNAPSHOT را بازنشانی کنید

mvn -Dchangelist= بسته تمیز

*نمونه های بالا برگرفته از مقاله در وب سایت Maven Apache Project

واقعیت تلخ

همه چیز خوب و سالم است، وقت آن است که احساس رضایت کنید، اما نه. به نظر می رسد که این روش برای نصب و استقرار کار نخواهد کرد، زیرا در توضیحات مصنوعات منتشر شده در مخزن جایگزین نمی شود. ${بازبینی} به معنای آن است و ماون دیگر متوجه نخواهد شد که در مورد چیست.

    org.apache
    آپاچی
    ${بازبینی}

نوری در انتهای یک تونل

ما باید به دنبال راه حلی برای مشکل باشیم. می توانست وضعیت را نجات دهد flatten-maven-plugin. این افزونه تمام متغیرهای موجود در pom را حل می کند، اما در عین حال بسیاری از اطلاعات دیگر را که فقط در هنگام مونتاژ مورد نیاز هستند و هنگام وارد کردن مصنوعات منتشر شده به پروژه های دیگر مورد نیاز نیستند، حذف می کند. این افزونه همچنین تمام وابستگی‌های والدین-فرزند را «راست می‌کند» و در نتیجه، یک پوم صاف دریافت می‌کنید که شامل همه چیزهایی است که نیاز دارید. ناراحتی این بود که بیش از حد "اضافی" را حذف می کند که اصلاً برای ما مناسب نبود. پس از مطالعه اطلاعات مربوط به توسعه این افزونه، مشخص شد که ما تنها در جهان نیستیم و در آگوست 2018، یک درخواست کشش در Github در مخزن پلاگین ایجاد شد که می خواست این امکان را فراهم کند. تا خودمان تعیین کنیم که چگونه pom.xml را "فاسد" کنیم. توسعه دهندگان به صدای کسانی که در رنج بودند گوش دادند و در ماه دسامبر، با انتشار نسخه جدید 1.1.0، حالت جدیدی به نام solveCiFriendliesOnly در پلاگین flatten-maven ظاهر شد که مناسب تر از همیشه بود - آن را ترک می کند. pom.xml همانطور که هست، به جز عنصر و اجازه می دهد ${بازبینی}, ${sha1} и ${changelist}.

افزودن افزونه به پروژه

    org.codehaus.mojo
    flatten-maven-plugin
    1.1.0

      درست است، واقعی
      solveCiFriendliesOnly



        صاف کردن
        فرآیند-منابع

          صاف کردن



        صاف کردن.تمیز کردن
        تمیز

          تمیز

انجام شده است

پایان خوش

از این به بعد، برای اینکه نسخه کل پروژه را تغییر دهیم و همه وابستگی ها از آن مطلع شوند، فقط باید عنصر را ویرایش کنیم.تجدید نظر> فقط در ریشه pom.xml. صد و دو تا از این فایل ها با همین تغییر به بررسی نمی رسند، بلکه یکی. خب نیازی به استفاده نیست نسخه-maven-پلاگین.

منبع: www.habr.com