1. Projektowanie i rozwój witryn internetowych GitHub Marketplace

Sarah Guthals

Wiele narzędzi rozszerza lub integruje się z GitHub. Dobrym sposobem na znalezienie narzędzi do korzystania z GitHub jest GitHub Marketplace. GitHub Marketplace to katalog narzędzi i aplikacji pogrupowanych w następujących kategoriach:

  • Czat Jakość kodu Przegląd kodu Ciągła integracja Zarządzanie zależnościami Rozlokowanie Uczenie się Lokalizacja mobilny Monitorowanie Zarządzanie projektami Wydawniczy Ostatnio dodane Bezpieczeństwo Wsparcie Testowanie Narzędzia

Marketplace to świetny sposób na znalezienie aplikacji na każdą sytuację w GitHub. Kupowanie lub instalowanie aplikacji przez Marketplace ma dwie kluczowe zalety: łatwość naliczania i instalacji oraz proces weryfikacji.

Łatwe rozliczanie w witrynie GitHub Marketplace

W przypadku aplikacji w GitHub Marketplace, które wymagają płatności, instalacja aplikacji za pośrednictwem Marketplace jest usprawniona, ponieważ możesz korzystać z informacji o płatności GitHub. W ten sposób nie masz do czynienia z pięcioma różnymi dostawcami płatności przy zakupie pięciu różnych aplikacji do korzystania z GitHub.

Jeśli masz bezpłatne konto GitHub, być może nie skonfigurowałeś informacji o płatności w GitHub. Aby skonfigurować metodę płatności, kliknij swój awatar w prawym górnym rogu strony GitHub.com i kliknij Ustawienia. Na tej stronie kliknij Płatności z listy po lewej stronie. Tutaj możesz kliknąć Dodaj metodę płatności, jak pokazano.

Formularz rozliczeniowy GitHub

Proces weryfikacji w witrynie GitHub Marketplace

Jedną z zalet instalowania aplikacji z Marketplace jest to, że aplikacje te muszą spełniać określone wymagania, zanim GitHub umieści je na liście w Marketplace. Wymagania pomagają zapewnić wyższy standard jakości i bezpieczeństwa aplikacji; pomagając upewnić się, że te aplikacje są przydatne (bez aplikacji Fart) i są bezpieczne.

W tej chwili Akcja GitHub nie wymaga umieszczania recenzji na GitHub Marketplace, co oznacza, że ​​instalacja akcji od kogoś, kogo nie znasz, może być nieco bardziej ryzykowna.

Aplikacja musi spełniać cztery główne kategorie wymagań, zanim zostanie wymieniona na rynku:

  • Doświadczenie użytkownika: ten krótki zestaw dziewięciu wymagań obejmuje takie rzeczy, jak aplikacja musi mieć określoną liczbę użytkowników i już ją instaluje. Zawiera także pewne wymagania dotyczące zachowania aplikacji, takie jak aplikacja musi zawierać linki do dokumentacji, nie może aktywnie przekonywać użytkowników do GitHub i musi zapewniać wartość dla klientów. Marka i wpis: ten zestaw wskazówek i rekomendacji skupia się na brandingu Twojej aplikacji i jej wpisie. Każda aplikacja musi zawierać własne logo. Jeśli aplikacja korzysta z logo GitHub, musi być zgodna z wytycznymi GitHub dotyczącymi logo i użytkowania. Sekcja marki i wykazu na stronie wymagań zawiera linki do dalszych wskazówek dotyczących logo i opisu. Jak widać, GitHub poważnie traktuje listę aplikacji w Marketplace. Bezpieczeństwo: GitHub przeprowadzi przegląd bezpieczeństwa aplikacji przed umieszczeniem ich na rynku. Dostępny jest osobny dokument z najlepszymi praktykami bezpieczeństwa i szczegółowymi informacjami na temat przeglądu bezpieczeństwa. Przepływy rozliczeniowe: każda aplikacja w Marketplace musi integrować przepływy rozliczeniowe za pomocą zdarzenia webhook GitHub Marketplace. Ten wymóg zapewnia, że ​​użytkownicy mogą zakupić subskrypcję Twojej aplikacji i anulować tę subskrypcję za pomocą informacji o płatności, które mają już zapisane w GitHub. Zapewnia również, że wszelkie zmiany wprowadzone za pośrednictwem GitHub są natychmiast odzwierciedlane na własnej stronie internetowej aplikacji.

Jak wyświetlić swoją aplikację na GitHub Marketplace

Umieszczenie własnej aplikacji na liście w Marketplace może zwiększyć potencjalną grupę odbiorców tej aplikacji. Jednak umieszczenie aplikacji na liście wymaga spełnienia wymagań GitHub i uzyskania zatwierdzenia.

Aby rozpocząć proces umieszczania aplikacji na liście, kliknij link Prześlij swoje narzędzie do sprawdzenia na dole strony docelowej Marketplace lub przejdź do nowej strony GitHub Marketplace w przeglądarce.

Ta strona zawiera listę aplikacji, które możesz przekształcić w aukcje w Marketplace, jak pokazano na poniższym rysunku.

Informacje o aplikacjach GitHub

Kliknij Utwórz kopię roboczą listy obok aplikacji, którą chcesz wyświetlić w portalu Marketplace, aby rozpocząć proces. Spowoduje to przejście do strony, na której możesz wpisać nazwę wpisu i wybrać jedną z kategorii rynku aplikacji, jak pokazano.

Formularz aplikacji GitHub

Jeśli zapiszesz wersję roboczą swojego wpisu, ale zdarzy ci się zamknąć przeglądarkę, możesz wrócić do swojego wpisu w przeglądarce.

Po wypełnieniu tych informacji kliknij Zapisz i dodaj więcej szczegółów, aby zapisać wersję roboczą swojego wpisu i przejść do następnego zestawu kroków, jak pokazano.

Przesyłanie z GitHub Marketplace

Te kroki obejmują

  1. Dodaj swoje dane kontaktowe. Te informacje to zestaw trzech adresów e-mail: potencjalny klient techniczny, marketingowy i finansowy. Uzupełnij opis swojej oferty. W tym obszarze podajesz dodatkowe informacje, takie jak opis produktu, logo i zrzuty ekranu. Informacje tutaj zostaną wyświetlone na stronie Marketplace dla Twojej aplikacji. Skonfiguruj plany i ceny. W tym miejscu możesz skonfigurować jeden lub więcej planów cenowych, w tym opcję utworzenia planu bezpłatnego, abonamentu miesięcznego lub abonamentu miesięcznego na użytkownika. Możesz także określić, czy plan obejmuje 14-dniowy bezpłatny okres próbny. Skonfiguruj hak internetowy. Ten krok umożliwia określenie adresu URL, na który będą wysyłane zdarzenia z Marketplace za pośrednictwem żądania HTTP POST. Hak internetowy wyśle ​​Ci informacje o zdarzeniach, takich jak zakupy, anulowania i zmiany, takie jak uaktualnienia i obniżki. Zaakceptuj umowę dewelopera z Marketplace. Aby wyświetlić swoją aplikację na rynku, musisz zaakceptować umowę dewelopera z Marketplace. Kliknij przycisk Prześlij do recenzji. Pracownicy GitHub sprawdzą Twoje zgłoszenie, aby upewnić się, że spełnia ono wymagania, aby znaleźć się na rynku.

Rozważ typowe aplikacje do zainstalowania

Oto niektóre z najbardziej popularnych i przydatnych aplikacji GitHub, które warto rozważyć zainstalowanie.

Ciągła integracja

Aplikacje do ciągłej integracji (CI) automatycznie budują i testują kod za każdym razem, gdy przekazujesz go do GitHub. Jeśli masz aplikację CI, taką jak AppVeyor, zainstalowaną w twoim repozytorium, zobaczysz status kontroli na dole każdego żądania ściągnięcia, jak pokazano.

GitHub AppVeyor CI

Jeśli jesteś właścicielem repozytorium, możesz także określić, czy czek musi przejść, zanim gałąź będzie mogła zostać scalona z gałęzią główną. Po prostu przejdź do karty Ustawienia. Jeśli masz już jakieś reguły w gałęzi master, kliknij edytuj; w przeciwnym razie kliknij Dodaj regułę. Stamtąd możesz przewinąć w dół i wybrać opcję Wymagaj sprawdzania stanu przed połączeniem.

Jakość kodu

Aplikacje jakości kodu automatycznie sprawdzają kod za pomocą kontroli stylu, jakości, bezpieczeństwa i pokrycia testowego. Te aplikacje mogą być bardzo przydatne do zapewnienia wysokiego poziomu kodu. Dzięki dobrze zaprojektowanemu i jakościowemu kodowi masz mniejsze szanse na wprowadzenie błędów lub pominięcie ich. Na przykład, jeśli potrzebujesz, aby wszystkie nawiasy klamrowe znajdowały się w nowych liniach i były wcięte jedną tabulacją na zagnieżdżone nawiasy klamrowe, prawdopodobnie zauważysz, że coś jest nie tak. Na przykład Rubocop sprawdza styl kodu Ruby podczas jego tworzenia i zapewnia informacje zwrotne dotyczące stylu, takie jak wielkość liter dla nazw metod.

Innym przydatnym typem aplikacji jakości kodu są aplikacje do pokrycia kodu, takie jak Codecov. Przedstawiony na poniższym rysunku Codecov i podobne aplikacje komentują żądania ściągania wraz z tym, jaka część kodu jest objęta scenariuszami testowymi, pomagając zapewnić, że kod pozostaje dobrze przetestowany.

Aplikacja GitHub Codecov

Lokalizacja

Aplikacje lokalizacyjne mogą ułatwić publikowanie aplikacji w wielu językach. Na przykład aplikacja Crowdin połączy Twoje repozytorium z kontem Crowdin, na którym ludzie z całego świata mogą pomóc Ci przetłumaczyć twoją dokumentację i wszelkie napisane słowa w twoim oprogramowaniu (na przykład na przyciskach lub w menu). Ponieważ ponad 20 000 osób uczestniczy w tłumaczeniach, aplikacja Crowdin automatycznie otworzy żądanie repozytorium w twoim repozytorium z nowymi tłumaczeniami, gdy osiągnie próg dokładności, nadal dając ci szansę na przejrzenie i scalenie. W przypadku projektów open source Crowdin jest bezpłatny!

Monitorowanie

Aplikacje monitorujące pomagają mierzyć wydajność, śledzić błędy i śledzić zależności w kodzie. Na przykład Greenkeeper to aplikacja do powiadamiania w czasie rzeczywistym, która zapewnia aktualizacje i zmiany w zależnościach JavaScript. Ten rysunek pokazuje Greenkeepera w akcji, otwierając żądanie ściągnięcia w celu zaktualizowania eslinta do najnowszej wersji.

Aplikacja GitHub Greenkeeper

Zarządzanie zależnościami

Dzisiejsze tworzenie aplikacji jest silnie uzależnione od publicznych menedżerów pakietów do pobierania i zarządzania zależnościami. Typowa aplikacja może mieć dziesiątki, jeśli nie setki zależności. Śledzenie, które z tych zależności są aktualne, może być trudne. Aplikacje Github, takie jak Dependabot, sprawdzają, czy Twoje zależności są aktualne i przesyłają żądania ściągania, aby zaktualizować te, które nie są.

Czasami nie chcesz wszystkich swoich zależności w publicznym rejestrze paczek. Na przykład, jeśli pracujesz w przedsiębiorstwie, możesz mieć pakiety wewnętrzne, które powinny pozostać prywatne. W takim przypadku przydatne jest narzędzie do rejestrowania pakietów prywatnych, takie jak MyGet. MyGet współpracuje z pakietami NuGet i pozwala skonfigurować zasady, w których wypychanie do konkretnej gałęzi zainicjuje kompilację, a gałąź zostanie wdrożona na niestandardowym kanale NuGet hostowanym na MyGet.

Testowanie

Testowanie oprogramowania jest ważną częścią cyklu życia oprogramowania. Dobrzy testerzy opracowują plany testów, aby upewnić się, że testerzy wykonują dobrą robotę testując każde wydanie. Zarządzanie planami testów i śledzenie statusu przebiegów testów jest ważną częścią zapewniania jakości. Aplikacja TestQuality integruje się z GitHub, aby pomóc programistom i testerom tworzyć, uruchamiać, koordynować i monitorować zadania testowania oprogramowania.

Uczenie się

Świetnym sposobem na naukę GitHub jest zainstalowanie GitHub Learning Lab z Marketplace. Instalując Learning Lab zainstaluj bota, który przeprowadzi Cię przez interaktywne lekcje na temat korzystania z GitHub przez zestaw zadań, które wykonałeś. Laboratorium jest bezpłatne i pozwala ci odbywać tyle kursów, ile chcesz we własnym tempie.