გადადით შინაარსზე

Gradle ბილდის ინსაიტები

Tuist-ის Gradle პლაგინს შეუძლია გაგზავნოს ბილდის ანალიტიკა Tuist-ში, რაც საშუალებას გაძლევთ დაინახოთ ამოცანების შესრულება და ბილდის წარმადობა.

ატვირთვის ქცევის კონფიგურაცია#

ნაგულისხმევად:

  • ლოკალური ბილდებისთვის ბილდის ანალიტიკა იტვირთება ფონურ რეჟიმში.
  • CI გაშვებებისთვის ბილდის ანალიტიკა იტვირთება წინა პლანზე, რათა თავიდან ავიცილოთ ტელემეტრიის დაკარგვა ხანმოკლე აგენტებზე.

ამ ქცევის მართვა შეგიძლიათ uploadInBackground-ის გამოყენებით tuist გაფართოების შიგნით:

kotlin
tuist {
uploadInBackground = false // always upload in the foreground
}

კონფიგურაციის ცნობარი#

uploadInBackground ოფცია ხელმისაწვდომია tuist გაფართოების ბლოკში settings.gradle.kts-ში:

ოფცია ტიპი ნაგულისხმევი აღწერა
uploadInBackground Boolean? null (ლოკალურად — ფონურ რეჟიმში, CI-ზე — წინა პლანზე) ატვირთოს თუ არა ბილდის ინსაიტები ფონურ რეჟიმში ლოკალური ბილდებისთვის.

ეს პარამეტრი არ მოქმედებს დისტანციური ქეშის პარამეტრებზე buildCache ბლოკში.

აქტორის მოთხოვნის ანგარიში#

ბილდისა და ტესტის ანგარიშის მოთხოვნები მოიცავს არასავალდებულო x-tuist-actor-id ჰედერს მხოლოდ მაშინ, როცა ცალსახად ანიჭებთ TUIST_ACTOR_ID-ს ორგანიზაციის მასშტაბის იარლიყს ან აკონფიგურირებთ buildInsights.actorId-ს თქვენს პარამეტრებში. ნაგულისხმევად იარლიყი არ იგზავნება და პლაგინი არ აღმოაჩენს ოპერაციული სისტემის მომხმარებლის სახელებს. გარემოს გადაფარვა უპირატესობას იღებს. ნებისმიერი გადაფარვის ცარიელ სტრიქონად დაყენება გამოტოვებს ანგარიშგებულ იდენტიფიკატორს; ეს არ ხსნის ინდივიდუალური სერთიფიკატებით დამყარებულ იდენტობას. არასწორი გადაფარვები გამოტოვებენ მოთხოვნას და არ ბრუნდებიან სათადარიგო ვარიანტზე. თუ მორგებული პროქსი უარყოფს უცნობ ჰედერებს, გამორთეთ ის TUIST_ACTOR_ID=""-ით.

kotlin
tuist {
buildInsights {
actorId = providers.environmentVariable("CORPORATE_ACTOR_ID").getOrElse("")
}
}

აქტორის იდენტიფიკატორები არის 1–128 ბაიტიანი, არა-სივრცითი, ბეჭდავადი ASCII სიმბოლოები. ისინი ჩანს ყველასთვის, ვისაც შეუძლია ნახოს პროექტის ანგარიშები, მათ შორის საჯარო მაყურებლებისთვის, როცა პროექტი საჯაროა, და ექსპორტირდება ანგარიშებთან ერთად. არ ჩართოთ საიდუმლოებები ან პირადი ინფორმაცია, რომლის გამოქვეყნებაც არ გსურთ. დადასტურებული ინდივიდუალური სერთიფიკატი იღებს უპირატესობას დაშბორდზე; კლიენტების მიერ გაგზავნილი იდენტიფიკატორები სხვა შემთხვევაში ცალსახად დაუდასტურებელი-აა. ისინი არასდროს ანიჭებენ უფლებებს ან ავტომატურად არ აკავშირებენ Tuist მომხმარებელთან. ძველი სერვერები იგნორირებენ მიკუთვნების ჰედერს, ხოლო ახალი სერვერები აგრძელებენ ძველი კლიენტების მიღებას მის გარეშე. ახალი საერთო-ტოკენის ანგარიშები იდენტიფიკატორის გარეშე აჩვენებენ უცნობი-ს, გამომქვეყნებელი ორგანიზაციის ნაცვლად; ისტორიული ანგარიშები ინარჩუნებენ წინა მიკუთვნებას. ბილდისა და ტესტის სიები გამოყოფენ დადასტურებული მომხმარებლის ფილტრებს დაუდასტურებელი ანგარიშგებული იდენტიფიკატორის ფილტრებისგან.

ქსელის სანდოობაზე დაფუძნებული გამოქვეყნება#

თვითმასპინძელ განლაგებებს შეუძლიათ ცალსახად დაუშვან Gradle ბილდისა და ტესტის ანგარიშები მათი სანდო ქსელიდან დეველოპერის სერთიფიკატების გარეშე. ოპერატორმა ჯერ უნდა დააკონფიგურიროს TUIST_NETWORK_TRUSTED_INSIGHTS_ACCESS=true ინსტანსზე და გადატვირთოს ის. ეს ვრცელდება ყველა მხარდაჭერილ პროექტზე; დაშბორდზე შესაბამისი პარამეტრი არ არსებობს. იხილეთ თვითმასპინძლობის სახელმძღვანელო.

დააკონფიგურირეთ დანიშნულება ერთხელ რეპოზიტორიაში:

kotlin
tuist {
project = "organization/project"
url = "https://tuist.internal.example"
buildCache { enabled = false }
}

ბილდისა და ტესტის ანგარიშგება არ საჭიროებს ავთენტიკირებულ ქეშის ბოლოწერტილის აღმოჩენას. გათიშეთ ქეში, თუ ინსტანსი ცალკე არ ააქტიურებს ქსელის სანდოობაზე დაფუძნებულ ქეშის წვდომას ან დეველოპერები არ ამზადებენ ტოკენებს. ხელმოუწერი ტესტის ანგარიშები გამოტოვებენ შარდისა და არსებული ბილდის მითითებებს და არ ამუშავებენ კარანტინის ან ფლაკის ავტომატიზაციებს. კარანტინის ძებნა გამოიტოვება, როცა სერთიფიკატები ნამდვილად არ არის; მოქმედი სერთიფიკატებით ინარჩუნება არსებული ავთენტიკირებული ქცევა. თუ სერთიფიკატები არსებობს, ისინი კვლავ გამოიყენება და არასწორი სერთიფიკატები ასრულებენ შეცდომით, ნაცვლად სერთიფიკატების გარეშე გამოქვეყნებაზე დაბრუნების. როცა სერთიფიკატები არ არის, პლაგინი ავტომატურად აღმოაჩენს, ნებას რთავს თუ არა თვითმასპინძელი სერვერი სერთიფიკატების გარეშე ანგარიშგებას. არ არის საჭირო არც კლიენტის ფლაგი და არც buildInsights პარამეტრი. სანამ განაახლებთ სერთიფიკატების გარეშე მომუშავე კლიენტებს, განაახლეთ სერვერის ყოველი რეპლიკა აღმოჩენის შესაძლებლობის მქონე ვერსიამდე. უფრო ძველ სერვერებს აღმოჩენის გარეშე, გათიშულ ინსტანსებს და აღმოჩენის შეცდომებს კვლავ სჭირდებათ ავთენტიკაცია; ავთენტიკირებული გამოქვეყნება რჩება თავსებადი. ცალსახად ცარიელი TUIST_TOKEN იწვევს უსაფრთხო შეცდომას, ნაცვლად სერთიფიკატების გარეშე გამოქვეყნების ჩართვის. ფორკის ან Dependabot სამუშაოებისთვის საიდუმლოებების გარეშე, წაშალეთ ეს ცვლადი, ნაცვლად მისი ცარიელ სტრიქონად განსაზღვრის.

სერვერი ანიჭებს სერთიფიკატების გარეშე ანგარიშის ID-ებს. წარდგენის გამეორებამ შეიძლება შექმნას მეორე ანგარიში; ეს რეჟიმი არ იძლევა იდემპოტენტური განმეორებების ან ავთენტიკირებულ ტესტის ანგარიშებთან კორელაციის გარანტიას. ასეთ ანგარიშებს არ შეუძლიათ VCS კომენტარების ან ავტომატური შეცდომის-აგენტის მოვლენების გამოწვევა. ქსელის წვდომა არის გამოქვეყნების ნდობის საზღვარი, არა ანგარიშგებული აქტორის იდენტობის დადასტურება.

მორგებული მეტამონაცემები#

მიამაგრეთ ტეგები და გასაღები-მნიშვნელობის მონაცემები Gradle ბილდებს, რათა შეადაროთ გაშვებები სხვადასხვა გუნდების, აპარატურის ან სამუშაო ნაკადების მიხედვით. ტეგები ხელმისაწვდომია დაშბორდის ფილტრებში, ხოლო მნიშვნელობები ჩანს თითოეული ბილდის დეტალურ გვერდზე, აპლიკაციის პროგრამირების ინტერფეისში და Model Context Protocol ინსტრუმენტებში.

დააყენეთ მეტამონაცემები გარემოს ცვლადებით:

bash
export TUIST_BUILD_TAGS="nightly,android"
export TUIST_BUILD_VALUE_TICKET="TUIST-123"
export TUIST_BUILD_VALUE_RUNNER="macos-14"

მეტამონაცემების კონფიგურაცია ასევე შეგიძლიათ settings.gradle.kts-ში:

kotlin
tuist {
buildInsights {
tag("nightly")
tag("android")
value("ticket", "TUIST-123")
value("runner", "macos-14")
}
}

როცა ერთი და იგივე მნიშვნელობა კონფიგურირებულია ორივე ადგილას, უპირატესობას იღებს settings.gradle.kts-ში მითითებული მნიშვნელობა.

ტეგებმა უნდა შეიცავდნენ მხოლოდ ასოები, ციფრები, დეფისები და ქვედა ტირეები. ბილდს შეიძლება ჰქონდეს მაქსიმუმ 50 ტეგი და თითოეულ ტეგს შეიძლება ჰქონდეს მაქსიმუმ 50 სიმბოლო. ბილდს შეიძლება ჰქონდეს მაქსიმუმ 20 გასაღები-მნიშვნელობის ჩანაწერი, თითოეულ გასაღებს შეიძლება ჰქონდეს მაქსიმუმ 50 სიმბოლო, ხოლო თითოეულ მნიშვნელობას — მაქსიმუმ 500 სიმბოლო. ეს იგივე სერვერის მხარის ლიმიტებია, რომლებიც გამოიყენება Xcode ბილდის მეტამონაცემებისთვის. პლაგინი გამოტოვებს არასწორ ტეგებსა და ზედმეტად დიდ ან ცარიელ მეტამონაცემთა ჩანაწერებს ანგარიშის გაგზავნამდე, ამიტომ არასწორმა კონფიგურაციამ ვერ შეუშლის ხელი ბილდის ინსაიტების ანგარიშის დანარჩენი ნაწილის შენახვას. გამოიყენეთ გასაღები-მნიშვნელობის მეტამონაცემები მნიშვნელობებისთვის, რომლებიც არ აკმაყოფილებენ ტეგის შეზღუდვას.

მორგებული მეტამონაცემები ჩანს პროექტის წევრებისთვის დაშბორდში, აპლიკაციის პროგრამირების ინტერფეისისა და Model Context Protocol ინსტრუმენტების მეშვეობით. არ გამოიყენოთ ის სერთიფიკატების, წვდომის ტოკენების ან სხვა მგრძნობიარე მონაცემებისთვის. Tuist ინარჩუნებს Gradle ბილდის მონაცემებს, ამ მეტამონაცემების ჩათვლით, 90 დღის განმავლობაში. დეტალებისთვის იხილეთ მონაცემთა შენახვის პოლიტიკა.

შეცდომის დეტალები#

როდესაც ბილდი ვერ მთავრდება, პლაგინი აფიქსირებს თითოეული წარუმატებელი ამოცანის ან კონფიგურაციის ნაბიჯის ჩავარდნის მიზეზს: გამონაკლისის შეტყობინებას და მისი მიზეზების ჯაჭვს, როგორც Gradle-ის კონსოლი ბეჭდავს, მაგალითად, წარუმატებელი compileJava ამოცანის კომპილატორის შეცდომებს ან ბილდის სკრიპტში არსებულ შეცდომას. სტეკის ტრეისები და ამოცანის გამოტანა არ იკრიბება. პლაგინი რეპორტის გაგზავნამდე პროექტის შიგნით არსებულ გზებს ფარდობითად აქცევს, ხოლო Tuist ფარავს სერთიფიკატებს და სხვა ცნობად ლოკალურ გზებს. თითოეული შეტყობინება შემოიფარგლება 16 KiB-ით, ხოლო ბილდი ინახავს მაქსიმუმ 32 წარუმატებელი ნაბიჯის შეტყობინებებს.

შეცდომის შეტყობინებები ხელმისაწვდომია პროექტის წევრებისთვის აპლიკაციის პროგრამირების ინტერფეისის, Model Context Protocol ინსტრუმენტების (get_gradle_build, list_gradle_build_tasks და get_gradle_build_step) და CLI-ის მეშვეობით:

bash
tuist build gradle failure list <build-id>

შეტყობინებებმა შეიძლება შეიცავდნენ კოდის ფრაგმენტებს და პროექტის დეტალებს. რეპორტები, რომლებიც გამოქვეყნებულია სერთიფიკატების გარეშე ქსელში სანდო გამოქვეყნების საშუალებით, არ შეიცავს მათ. Tuist ინარჩუნებს მათ Gradle-ის ბილდის დანარჩენ მონაცემებთან ერთად 90 დღის განმავლობაში.