اتصال GitHub

این راهنما فرایند کامل راه‌اندازی را توضیح می‌دهد: اتصال حساب GitHub شما به Atoms، ایجاد مخزن، تأیید اینکه اتصال کار می‌کند، و همگام نگه داشتن نسخه‌های پروژه شما در Atoms و GitHub.

نحوه کار اتصال

اتصال GitHub شامل 2 مرحله است:

1. حساب GitHub خود را متصل کنید. این به Atoms اجازه می‌دهد از طرف شما با GitHub کار کند.
2. برای پروژه خود یک مخزن ایجاد کنید. مخزن فضای خصوصی در GitHub است که کد پروژه و تاریخچه تغییرات شما در آن ذخیره می‌شود.

Atoms در حال حاضر یک مخزن خصوصی جدید در حساب شخصی GitHub کاربر متصل‌شده ایجاد می‌کند. شما نمی‌توانید به یک مخزن موجود متصل شوید، مخزن را تحت یک organization ایجاد کنید، یا از طریق این connector آن را عمومی کنید.

پیش از شروع

پیش از اتصال پروژه خود به GitHub، مطمئن شوید که:

• پلن Atoms شما شامل اتصال GitHub. اگر در پلن Free هستید، انتخاب GitHub شما را به صفحه Plans می‌برد.
• فقط مالک workspace می‌تواند GitHub را متصل یا قطع کند. اگر editor هستید، از مالک workspace بخواهید این مرحله را انجام دهد.
• شما یک حساب GitHub دارید یا آماده‌اید در حین راه‌اندازی یکی ایجاد کنید.
• مرورگر شما پنجره‌های pop-up از Atoms را مجاز می‌داند.
• هیچ Agents در حال حاضر روی پروژه شما کار نمی‌کنند.

برای اتصال حساب خود به token دسترسی شخصی GitHub نیازی ندارید. هرگز tokenهای GitHub، گذرواژه‌ها یا سایر اطلاعات اعتباری را در Chat جای‌گذاری نکنید.

حساب GitHub خود را متصل کنید

connector مربوط به GitHub را باز کنید

1. پروژه‌ای را که می‌خواهید متصل کنید باز کنید.
2. روی نام پروژه، در بالای سمت راست پنل chat، کلیک کنید.
3. گزینه Connectors را در منوی کشویی که ظاهر می‌شود انتخاب کنید.
4. مورد Github را در فهرست connectorهای موجود پیدا کنید و روی connect.

همچنین می‌توانید Settings → Connectors → GitHub را باز کنید و Connect.

Settings → Connectors را باز کنید و برای GitHub گزینه Connect را انتخاب کنید.

Atoms را در GitHub مجاز کنید

اگر Connected Account از قبل حساب GitHub موردنظر شما را نشان می‌دهد، یعنی قبلاً مجاز شده است. می‌توانید به ایجاد یک مخزن خصوصی.

1. Atoms یک پنجره مجوز GitHub باز می‌کند. به حساب GitHubی که می‌خواهید متصل کنید وارد شوید، یا در صورت نیاز یک حساب جدید ایجاد کنید.
2. بررسی کنید که به حساب درست GitHub وارد شده باشید.
3. مجوزهایی را که Atoms درخواست کرده بررسی کنید. اگر موافق هستید، گزینه Authorize Atoms-Agents.
4. را انتخاب کنید. به Atoms برگردید و منتظر پیام Connect success بمانید.
5. در Atoms، Connectors را باز کنید و تأیید کنید که حساب GitHub شما به‌عنوان متصل نمایش داده می‌شود.

Atoms مجوزهای repo, read:user، و workflow OAuth را درخواست می‌کند. این‌ها به Atoms اجازه می‌دهند مخازن عمومی و خصوصی‌ای را که حساب متصل به آن‌ها دسترسی دارد بخواند و در آن‌ها بنویسد، اطلاعات پایه پروفایل را بخواند، و فایل‌های workflow مربوط به GitHub Actions را اضافه یا به‌روزرسانی کند.

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

مجوزهای GitHub را بررسی کنید و Authorize Atoms-Agents را انتخاب کنید.

ایجاد یک مخزن خصوصی

پس از مجاز کردن حساب GitHub خود، مخزن خصوصی‌ای را ایجاد کنید که کد پروژه شما را ذخیره خواهد کرد.

1. در بخش Connected Account, بررسی کنید که نام کاربری نمایش‌داده‌شده با حساب GitHubی که می‌خواهید استفاده کنید مطابقت دارد.
2. در بخش Create New Repository, یک نام برای مخزن وارد کنید. نام باید:
   • بین 1 تا 100 نویسه داشته باشد؛
   • فقط از حروف، اعداد، خط تیره (-)، زیرخط (_)، یا نقطه (.).
3. گزینه Create.
4. منتظر پیام GitHub repository connected successfully! بمانید.

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

یک نام وارد کنید و یک مخزن خصوصی جدید ایجاد کنید.

بررسی کنید که اتصال درست کار کرده است

پیش از اتکا به مخزن، اتصال را هم در Atoms و هم در GitHub بررسی کنید.

1. در Atoms، تأیید کنید که Repository Status نشان می‌دهد Connected.
2. در بخش Branches, بررسی کنید که یک branch علامت تیک داشته باشد. این branch در حال حاضر به پروژه Atoms شما متصل است. اگر در GitHub تازه‌کار هستید، همین branch را انتخاب‌شده نگه دارید.
3. گزینه View on GitHub.
4. در GitHub، تأیید کنید که مخزن:
   • به حساب درست GitHub تعلق دارد؛
   • با برچسب Private;
   • مشخص شده است؛ فایل‌های مورد انتظار پروژه را دارد؛ و
   • حداقل یک commit.

اگر مخزن خالی است و Push Changes در Atoms در دسترس است، آن را انتخاب کنید و منتظر بمانید عملیات تمام شود. سپس صفحه مخزن را در GitHub تازه‌سازی کنید و بررسی کنید که فایل‌های پروژه اکنون نمایش داده می‌شوند.

مخزن متصل و branch انتخاب‌شده را در Atoms بررسی کنید.

مخزن خصوصی و فایل‌های پروژه را در GitHub تأیید کنید.

Atoms و GitHub را همگام نگه دارید

Atoms و GitHub به‌طور خودکار همگام نمی‌مانند. وقتی در یکی از دو طرف تغییراتی انجام شده باشد، از کنترل‌های همگام‌سازی برای انتقال آن تغییرات به طرف دیگر استفاده کنید.

اقدام	زمان استفاده	چه اتفاقی می‌افتد
Push Changes	در Atoms تغییراتی داده‌اید و می‌خواهید آن‌ها را به GitHub بفرستید.	Atoms فایل‌های فعلی پروژه را به branch انتخاب‌شده در GitHub می‌فرستد.
Pull Updates	در branch انتخاب‌شده در GitHub تغییراتی انجام شده و می‌خواهید آن‌ها را وارد Atoms کنید.	Atoms پروژه را با آخرین تغییرات GitHub به‌روزرسانی می‌کند.

پیش از push یا pull کردن تغییرات، منتظر بمانید تا Agent کارش را تمام کند و مطمئن شوید که آخرین نسخه پروژه را در Chat مشاهده می‌کنید. اگر یک نسخه قدیمی‌تر را از History, باز کرده‌اید، به کارت آخرین نسخه در پایین Chat برگردید، سپس دوباره GitHub.

را باز کنید. اگر روی آخرین نسخه نباشید، Atoms پیام You must be on the latest version to pull updates or push changes.

را نمایش می‌دهد. پیش از همگام‌سازی، همچنین بررسی کنید که branch انتخاب‌شده همان branchی باشد که می‌خواهید به‌روزرسانی کنید.

اگر هم Atoms و هم GitHub شامل تغییراتی هستند که باید حفظ شوند، هنوز آن‌ها را همگام نکنید. ابتدا یک کپی از کار مهم ذخیره کنید، یا از کسی که با GitHub آشناست بخواهید تغییرات را در یک branch جداگانه حفظ کند.

اگر Repository Status نشان می‌دهد Upstream Changes Available, GitHub شامل تغییراتی است که Atoms هنوز آن‌ها را ندارد. پیش از انتخاب یک اقدام، مخزن را بررسی کنید.

برای branch انتخاب‌شده از Pull Updates و Push Changes استفاده کنید.

تغییرات را از Atoms به GitHub push کنید

1. تغییرات خود را در Atoms کامل کنید و منتظر بمانید تا Agent از کار کردن متوقف شود.
2. مطمئن شوید که آخرین نسخه پروژه را مشاهده می‌کنید.
3. باز کنید Settings → Connectors → GitHub و بررسی کنید که branch درست انتخاب شده باشد.
4. گزینه Push Changes.
5. هنگام push شدن تغییرات، صفحه را باز نگه دارید.
6. وقتی Changes pushed successfully ظاهر شد، View on GitHub را انتخاب کنید و بررسی کنید که آخرین فایل‌های پروژه آنجا باشند.

Push Changes فقط زمانی در دسترس است که Atoms تغییراتی داشته باشد که هنوز به GitHub فرستاده نشده‌اند. این گزینه زمانی که Agent در حال کار است یا وقتی نسخه قدیمی‌تری از پروژه را مشاهده می‌کنید در دسترس نیست.

به‌محض اینکه Push Changes, را انتخاب کنید، تغییرات فوراً و بدون درخواست تأیید به GitHub فرستاده می‌شوند. اگر یک فایل یکسان هم در Atoms و هم در GitHub تغییر کرده باشد، نسخه موجود در Atoms اولویت دارد و نسخه‌ای را که اکنون در GitHub ذخیره شده بازنویسی می‌کند.

به‌روزرسانی‌ها را از GitHub به Atoms pull کنید

برخلاف push کردن، pull کردن تغییرات ابتدا به تأیید نیاز دارد. اگر یک فایل یکسان هم در GitHub و هم در Atoms تغییر کرده باشد، نسخه GitHub اولویت دارد و نسخه فعلی در Atoms را بازنویسی می‌کند.

1. باز کنید Settings → Connectors → GitHub.
2. بررسی کنید که Repository Status تغییرات جدید از GitHub را نشان می‌دهد و branch درست انتخاب شده است.
3. گزینه Pull Updates.
4. هشدار Pull May Affect Project را بخوانید. اگر می‌خواهید تغییرات GitHub را وارد پروژه فعلی Atoms خود کنید، Confirm.
5. را انتخاب کنید. هنگام pull شدن تغییرات، صفحه را باز نگه دارید.
6. وقتی Changes pulled successfully ظاهر شد، App Viewer را باز کنید و بخش‌های پروژه خود را که تحت تأثیر تغییرات قرار گرفته‌اند آزمایش کنید تا مطمئن شوید همه‌چیز همچنان طبق انتظار کار می‌کند.

Pull Updates فقط زمانی در دسترس است که branch انتخاب‌شده GitHub شامل تغییراتی باشد که هنوز وارد Atoms نشده‌اند.

قطع اتصال GitHub

وقتی دیگر نمی‌خواهید Atoms به حساب متصل‌شده دسترسی داشته باشد، GitHub را قطع کنید. مخزن GitHub و فایل‌های آن در GitHub باقی می‌مانند، اما Atoms دیگر نمی‌تواند تغییرات را push یا pull کند.

مجوز GitHub برای حساب متصل اعمال می‌شود. لغو دسترسی، اتصال همه پروژه‌های Atoms را که از آن حساب GitHub استفاده می‌کنند قطع می‌کند، بنابراین پیش از ادامه پروژه‌های دیگر خود را بررسی کنید.

1. باز کنید Settings → Connectors → GitHub.
2. گزینه Disconnect.
3. در پنجره قطع اتصال GitHub تأیید، Disconnect را دوباره انتخاب کنید.
4. GitHub باید صفحه مجوز مربوطه را به‌طور خودکار باز کند. اگر این‌طور نشد، در GitHub به Settings → Applications → Authorized OAuth Apps.
5. مورد Atoms, بروید، ... را در سمت راست ردیف آن انتخاب کنید، سپس Revoke. را انتخاب کنید. گزینه Revoke all; را انتخاب نکنید؛ آن اقدام دسترسی همه برنامه‌های OAuth مجاز فهرست‌شده در صفحه را حذف می‌کند.
6. هر مرحله تأییدی را که از طرف Github لازم است دنبال کنید.
7. به Atoms برگردید و دوباره GitHub connector را باز کنید تا تأیید شود که حساب دیگر متصل نیست.

در connector GitHub گزینه Disconnect را انتخاب کنید.

فقط برنامه OAuth مربوط به Atoms را در GitHub لغو دسترسی کنید.