Najpierw obejrzyj
Co będzie potrzebne
- Jira Cloud: adres kończący się na
.atlassian.net. - Konto Jira z uprawnieniem do tworzenia zgłoszeń w projekcie, do którego mają trafiać błędy.
- Uprawnienia administratora w przestrzeni roboczej UAT Studio.
Połączenie z projektem Jira
Utworzenie tokenu API w Atlassian
- Zalogować się do Atlassian kontem Jira, które będzie używane, i przejść do id.atlassian.com › Security › API tokens.
- Kliknąć Create API token.
- Nadać mu nazwę, którą łatwo będzie później rozpoznać, np. UAT Studio, i wybrać datę wygaśnięcia.
- Kliknąć Copy. Okno należy zostawić otwarte do wklejenia tokenu w kroku 5: Atlassian pokazuje go tylko raz.
Adres Jira i klucz projektu
Jira address: otworzyć Jira i spojrzeć na pasek adresu. Wszystko do .atlassian.net włącznie to Państwa adres, np. https://acme.atlassian.net.
Project key: krótki kod przed każdym numerem ticketu. W PORTAL-123 kluczem jest PORTAL. Widać go w ścieżce nawigacji u góry dowolnego ticketu w projekcie. Brak ticketów? Wystarczy otworzyć projekt i spojrzeć na pasek adresu: klucz znajduje się po /projects/.
Otwarcie Connections w UAT Studio
Zalogować się na app.uat.studio i otworzyć przestrzeń roboczą. Kliknąć Connections. Ta sama opcja jest też dostępna w Setup w każdym projekcie jako Manage connections.
Dodanie Jira i uzupełnienie ustawień
W Add a connection wybrać Jira i kliknąć Add.
Pojawi się karta nowego połączenia. Należy uzupełnić:
| Pole | Co wpisać |
|---|---|
| Name | Tekst przycisku: Send to Jira. Warto go zmienić przy łączeniu więcej niż jednego projektu, np. Portal Jira. |
| Jira address | Adres z kroku 2, np. https://acme.atlassian.net. |
| Email of the Jira account | Adres e-mail konta, które utworzyło token. |
| Project key | Klucz z kroku 2, wielkimi literami, np. PORTAL. |
| Issue type | Bug. Jeśli projekt nie ma typu Bug, należy użyć typu, którego zespół używa dla defektów, np. Task. |
Kliknąć Save settings.
Zapisanie tokenu
Wkleić token z kroku 1 w pole API token i kliknąć Store token. Pole pokazuje potem tylko 4 ostatnie znaki, aby było widać, który token jest zapisany.
Test połączenia
Kliknąć Test connection. UAT Studio loguje się do Jira przy użyciu tokenu i sprawdza projekt. Jeśli wszystko jest w porządku, pojawi się Connected as <name> to project <project>, a obok ostatniego testu OK.
Gotowe. Każdy projekt w tej przestrzeni roboczej może teraz wysyłać zgłoszenia do tego projektu Jira.
Wysyłanie zgłoszeń do Jira
Jedno zgłoszenie
Otworzyć zgłoszenie. W Ticket in the development team's system kliknąć Send to Jira.
Kilka sekund później ticket jest w Jira. W zgłoszeniu pojawia się numer ticketu i link, a historia zgłoszenia pokazuje, kiedy i przez kogo zostało wysłane. Zgłoszenia, które jest już powiązane, nie da się przypadkiem wysłać dwa razy.
Wszystkie zgłoszenia po spotkaniu triażowym
W Issues › Triage należy podjąć decyzję dla każdego nowego zgłoszenia. Na koniec UAT Studio liczy zgłoszenia do poprawy, które nie mają jeszcze ticketu. Kliknięcie Send 3 to Jira (lub odpowiedniej liczby) tworzy wszystkie tickety naraz.
Co zawiera ticket w Jira
- Tytuł: numer i tytuł zgłoszenia, np. ISS-012: Quote PDF shows the wrong VAT rate.
- Opis: to, co napisał tester, przypadek testowy z nieudanym krokiem i oczekiwanym wynikiem, środowisko oraz osoba, która znalazła błąd.
- Priorytet na podstawie wagi oraz etykiety
UATi numer zgłoszenia, aby można było według nich filtrować. - Link zwrotny do zgłoszenia w UAT Studio, gdzie są zrzuty ekranu.
Zrzuty ekranu są dołączane
Zrzuty ekranu i pliki zgłoszenia są dołączane do ticketu Jira: do 10 plików, każdy maksymalnie 10 MB. Plik, który się nie mieści, zostaje w UAT Studio, a historia zgłoszenia wskazuje, który to plik.
Scalanie duplikatów
Po scaleniu w UAT Studio dwóch zgłoszeń, które mają tickety, ticket duplikatu podąża za nimi: otrzymuje komentarz, link duplicates do drugiego ticketu i przechodzi do Done. Jeśli workflow na to nie pozwala, UAT Studio o tym informuje i ticket trzeba zamknąć w Jira samodzielnie. Jeśli ticket miał tylko duplikat, przejmuje go pozostające zgłoszenie.
Gdy poprawka w Jira jest gotowa
Gdy programista przeniesie ticket do statusu z kategorii Done, zgłoszenie w UAT Studio otrzymuje status Ready for retest, a tester dostaje e-mail z prośbą o ponowny test. Gdy ticket przejdzie do In Progress, zgłoszenie również. Status w Jira jest widoczny obok linku do ticketu.
Nieudany ponowny test nigdy nie jest cofany: jeśli tester ponownie otworzy zgłoszenie, gdy ticket jest nadal Done, UAT Studio zostawia je otwarte. Zamknięte zgłoszenie pozostaje zamknięte.
Samoczynnie lub od razu
Bez żadnych działań UAT Studio sprawdza status ticketu za każdym razem, gdy administrator otwiera zgłoszenia, oraz po kliknięciu przycisku Update ticket status.
Od razu: Jira informuje UAT Studio o każdej zmianie ticketu. Wymaga to uprawnień do tworzenia reguł automatyzacji w projekcie Jira.
- W UAT Studio, w Connections, w połączeniu Jira kliknąć Create webhook address i skopiować adres. Jest pokazywany tylko raz.
- W Jira otworzyć projekt i przejść do Project settings › Automation › Create rule.
- Wyzwalacz: Work item transitioned (w starszej Jira: Issue transitioned). Pola From i To zostawić puste.
- Akcja: Send web request. Web request URL: skopiowany adres. Method POST. Web request body: Issue data (Jira format).
- Nazwać regułę UAT Studio status i ją włączyć.
Kto może co robić
Gdy coś pójdzie nie tak
| Komunikat | Co zrobić |
|---|---|
| The token or email address is not accepted | Adres e-mail musi należeć do konta Atlassian, które utworzyło token. Należy sprawdzić literówki albo utworzyć nowy token i zapisać go ponownie. |
| The project … was not found | Należy sprawdzić klucz projektu oraz to, czy konto Jira ma dostęp do projektu. |
| Wysyłanie nie działa z powodu typu zgłoszenia | Projekt nie ma typu o tej nazwie. Należy sprawdzić typy w projekcie Jira i wpisać właściwy w Issue type. |
| Wcześniej działało, teraz nie | Token prawdopodobnie wygasł lub został unieważniony. Należy utworzyć nowy i go zapisać; reszta pozostaje bez zmian. |
| Status nie wraca | Należy otworzyć zgłoszenia jako administrator lub kliknąć Update ticket status. Przy adresie webhooka: sprawdzić, czy reguła automatyzacji jest włączona, i przejrzeć jej dziennik audytu w Jira; w Connections widać, kiedy przyszła ostatnia wiadomość. |
| Brak przycisku Send to Jira | Widzą go tylko administratorzy i tylko wtedy, gdy połączenie jest On i ma zapisany token. |
| Connections are not part of your plan | Połączenia są dostępne w planach Team, Business, Partner i Enterprise, a dla Project jako dodatek. Administrator może zmienić plan w Plan & billing. |
Nadal nie działa? Prosimy napisać na [email protected] i podać widoczny komunikat. Prosimy nigdy nie wysyłać nam samego tokenu.
Korzystają Państwo z Azure DevOps? Zobacz Połączenie UAT Studio z Azure DevOps. Wszystkie instrukcje: Pomoc UAT Studio.
Jak postępujemy z Państwa tokenem
- Token trafia z przeglądarki na nasz serwer jeden raz, szyfrowanym połączeniem.
- Jest przechowywany w postaci zaszyfrowanej (AES-256). Klucz do odszyfrowania jest przechowywany oddzielnie od bazy danych, więc sama kopia bazy jest bezużyteczna.
- Nikt nie może odczytać tokenu: ani w aplikacji, ani przez wsparcie.
- UAT Studio używa tokenu wyłącznie do testu połączenia, tworzenia wysyłanych ticketów (wraz z plikami), odczytu statusu tych ticketów i zamykania ticketu duplikatu po scaleniu. Nie odczytuje niczego innego w Państwa Jira.
- Po usunięciu połączenia lub unieważnieniu tokenu w Atlassian dostęp natychmiast się kończy.