یکپارچگی GitHub
از خطاهای ابرووا تریس خودکار issue در GitHub بسازید. هر خطای جدید یک issue با پیام کامل، جزئیات خطا و stack trace می‌شود.
از خطاهای ابرووا تریس خودکار issue در GitHub بسازید. هر خطای جدید یک issue با جزئیات خطا و stack trace کامل می‌سازد.
- یک حساب GitHub
- یک مخزن GitHub برای پیگیری issueها
- یک GitHub Personal Access Token
GitHub سرویسی بیرون از ایران است و ممکن است از برخی شبکه‌های داخل ایران در دسترس نباشد. برای راه‌اندازی و خواندن هشدارها به اتصالی نیاز دارید که به GitHub برسد، و issueها فقط وقتی ساخته می‌شوند که github.com و api.github.com پاسخ دهند؛ ارسال‌های ناموفق در لاگ ارسال یکپارچگی نمایش داده می‌شوند. اگر این برای تیم شما مشکل است، به‌جای آن یا در کنارش از یکپارچگی ایمیل یا Webhook استفاده کنید.
این‌که پروژه‌ی شما از کدام کانال‌ها می‌تواند استفاده کند، در صفحه‌ی ابرووا تریس ← یکپارچه‌سازی‌ها در کنسول ابرووا نمایش داده می‌شود.
ساختن GitHub Personal Access Token#
- به GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic) بروید
- روی «Generate new token» ← «Generate new token (classic)» کلیک کنید
- توکن را پیکربندی کنید:
- Note: «AbrovaTrace Integration»
- Expiration: ۹۰ روز توصیه می‌شود
- Scopes: گزینه‌ی
repoرا انتخاب کنید (کنترل کامل مخزن‌های خصوصی)
- روی «Generate token» کلیک کنید و توکن را همان لحظه کپی کنید
پیکربندی در ابرووا تریس#
- در کنسول ابرووا، ابرووا تریس ← یکپارچه‌سازی‌ها را باز کنید (یکپارچگی‌ها متعلق به پروژه‌ی انتخاب‌شده‌اند)
- روی «افزودن یکپارچه‌سازی» کلیک کنید و GitHub را انتخاب کنید (یا روی کارت GitHub «اتصال» را بزنید)
- یک نام وارد کنید و فیلدهای پیکربندی را پر کنید
- روی «ذخیرهٔ کانال» کلیک کنید، یا «ذخیره و ارسال تست» را بزنید تا ذخیره و بررسی شود
| گزینه | نوع | اجباری | توضیح |
|---|---|---|---|
| Name | string | بله | نامی آشنا (مثلاً «acme/web issues») |
| Personal access token | string | بله | توکنی که با ghp_ شروع می‌شود، از مرحله‌ی ۱؛ باید اجازه‌ی ساختن issue داشته باشد |
| Repository owner | string | بله | کاربر یا سازمان (مثلاً myorg) |
| Repository name | string | بله | مخزن (مثلاً my-app) |
بعد از ذخیره
مدیریت یکپارچگی‌ها (افزودن، ویرایش، روشن و خاموش کردن، حذف، تست) نقش admin یا owner می‌خواهد؛ همه‌ی نقش‌ها می‌توانند آن‌ها و لاگ ارسالشان را ببینند. نقش‌ها و دسترسی‌ها را ببینید.
توکن دسترسی شخصی بعد از ذخیره دیگر هرگز نمایش داده نمی‌شود: فرم آن را «تنظیم‌شده» نشان می‌دهد. دست نزنید تا توکن ذخیره‌شده بماند، یا جایگزینی را بزنید تا توکن تازه‌ای وارد کنید.
اگر صاحب یا نام مخزن را تغییر دهید، توکن را هم دوباره وارد کنید؛ توکن ذخیره‌شده هرگز خودبه‌خود برای مخزن دیگری استفاده نمی‌شود.
چه چیزی ساخته می‌شود#
وقتی خطای جدیدی شناسایی می‌شود (اولین باری که دیده می‌شود)، ابرووا تریس خودکار یک issue در GitHub با این محتوا می‌سازد:
- عنوان:
[AbrovaTrace] <error message>(مثلاً[AbrovaTrace] TypeError: Cannot read property 'map' of undefined) - جزئیات خطا: پروژه، محیط، زمان اولین دیده شدن و تعداد رخدادها
- Stack trace: stack کامل از رویداد خطا
- اطلاعات بیشتر: URL صفحه و user agent
تشخیص جهش هم اینجا issue باز می‌کند، و قوانین هشداری که به این کانال وصل می‌کنید، وقتی فعال شوند issueی با عنوان [AbrovaTrace Alert] <rule name> و برچسب abrovatrace-alert باز می‌کنند.
بهترین روش‌ها#
عنوان issueها با «[AbrovaTrace] …» شروع می‌شود، پس با فیلتر جست‌وجو راحت پیدا می‌شوند
پیش از منقضی شدن توکن یک یادآور در تقویم بگذارید
برای هر مخزنی که می‌خواهید issueها در آن ساخته شوند یک یکپارچگی GitHub اضافه کنید
عیب‌یابی#
issueها ساخته نمی‌شوند؟
- مطمئن شوید توکن دسترسی شخصی درست است
- مطمئن شوید توکن دسترسی «repo» را دارد
- مطمئن شوید صاحب و نام مخزن درست‌اند
- مطمئن شوید مخزن وجود دارد و به آن دسترسی دارید
- یکپارچگی را با دکمه‌ی «ارسال تست» تست کنید
- لاگ ارسال یکپارچگی را ببینید: timeout یا خطای اتصال یعنی GitHub در دسترس نبوده است
خطای احراز هویت؟
- ممکن است توکن منقضی شده باشد؛ توکن تازه بسازید، سپس یکپارچگی را ویرایش کنید و روی توکن «جایگزینی» را بزنید
- توکن دسترسی کافی ندارد
- ممکن است به مخزن دسترسی نداشته باشید
- توکن را با دسترسی «repo» دوباره بسازید
مخزن اشتباه؟
- صاحب و نام مخزن را در فیلدهای جداگانه وارد کنید
- «github.com» یا «https://» را ننویسید
- درست: صاحب
myorg، نامabrova-trace - نادرست:
github.com/myorg/abrova-trace