przewodnik użytkownika po tagach

Ten przewodnik pokazuje, jak korzystać z narzędzia interfejsu wiersza poleceń gactions w typowych scenariuszach użycia. Informacje na temat kompleksowego tworzenia akcji znajdziesz w dokumentacji tworzenia akcji konwersacyjnych.

Synchronizacja projektu

Jeśli korzystasz z pakietu Actions SDK, panele to Twoje narzędzie do synchronizowania projektów akcji między konsolą Actions a lokalnym systemem plików.

Operacje gactions pull eksportują projekt z konsoli Actions do lokalnego systemu plików, a operacje gactions push przesyłają projekt z lokalnego systemu plików do konsoli Actions.

Pobierz działania z Konsoli Actions

Uruchom gactions pull, aby skopiować konfigurację projektu Actions do lokalnego systemu plików.

Element project-id projektu, który chcesz skopiować, może być przekazywany w wierszu poleceń lub zapisywany w pliku settings/settings.yaml. Jeśli dostępne są oba rodzaje wartości, interfejs wiersza poleceń ma pierwszeństwo przed wartością przekazywaną jako opcję.

mkdir -p myAction/sdk
cd myAction/sdk
gactions pull --project-id my-project-id
Pulling your project files from Draft for a project id: "my-project-id"
✔ Done. You should see the files written in path/to/myAction/sdk
ls -l
total 8
drwxr-x---  3 user  primarygroup   96 May  7 10:00 actions
drwxr-x---  4 user  primarygroup  128 May  7 10:00 custom
-rw-r-----  1 user  primarygroup   15 May  7 10:00 manifest.yaml
drwxr-x---  3 user  primarygroup   96 May  7 10:00 settings
vi settings/settings.yaml
// change projectId to "my-other-project-id"
gactions pull
Pulling your project files from Draft for a project id: "my-other-project-id"
path/to/myAction/sdk/manifest.yaml already exists. Would you like to overwrite it?. [y/n]
...
✔ Done. You should see the files written in path/to/myAction/sdk

Powyższy fragment kodu pokazuje, jak pobrać akcję z wersji roboczej projektu. Możesz też pobrać dane z konkretnej wersji akcji. Wersja reprezentuje przesłaną kopię projektu Actions, którą można wdrożyć w kanale wersji.

Flaga --version-id określa wersję do pobrania.

mkdir -p myAction/sdk
cd myAction/sdk
gactions pull --project-id my-project-id --version-id my-version-id
Pulling version "my-version-id" of the project "my-project-id" from Actions Console...
✔ Done. You should see the files written in path/to/myAction/sdk
ls -l
total 8
drwxr-x---  3 user  primarygroup   96 May  7 10:00 actions
drwxr-x---  4 user  primarygroup  128 May  7 10:00 custom
-rw-r-----  1 user  primarygroup   15 May  7 10:00 manifest.yaml
drwxr-x---  3 user  primarygroup   96 May  7 10:00 settings

Użyj flagi --force, jeśli chcesz zastąpić lokalne kopie pliku bez pytania o potwierdzenie. Użyj flagi --clean, aby usunąć pliki lokalne, których nie ma w zdalnej wersji roboczej lub wersji. Użyj ich razem, aby uzyskać dokładną kopię projektu w Actions Console.

touch local_file.txt
gactions pull --force
Pulling your project files from Draft for a project id: "my-project-id"
[WARNING] 2020/05/07 17:34:32 path/to/myAction/sdk/local_file.txt is not present in the draft of your Action. To remove, run pull with --clean flag.
✔ Done. You should see the files written in path/to/myAction/sdk
gactions pull --force --clean
Pulling your project files from Draft for a project id: "my-project-id"
[WARNING] 2020/05/07 17:43:44 path/to/myAction/sdk/local_file.txt is not present in the draft of your Action. Removing path/to/myAction/sdk/local_file.txt.
✔ Done. You should see the files written in path/to/myAction/sdk

Przekazywanie działań do wersji roboczej projektu w Konsoli Actions

Uruchom gactions push, aby przekazać zmiany z lokalnego systemu plików do wersji roboczej akcji w konsoli. Ten proces może być przydatny na etapie programowania, ponieważ pozwala zobaczyć zmiany wprowadzone w konsoli Actions bez wpływu na wersję, która będzie udostępniana do testów.

gactions push
Pushing your project files to your Actions console draft for a project id: "my-project-id". This may take a few minutes.
Sending configuration files
Waiting for server to respond.
✔ Done. You can now navigate to the Actions Console: https://console.actions.google.com/project/my-project-id/overview to view your project. If you want to test your changes in the simulator, run "gactions deploy preview"

Zaimportuj istniejący projekt z systemu zarządzania kodem źródłowym

Jeśli chcesz pracować nad istniejącym projektem z wersji w systemie kontroli wersji:

  1. Sprawdź wersję docelową (w zależności od systemu).
  2. Zastąp wartość projectId w elemencie settings.yaml projektu.
  3. Opcjonalnie uruchom polecenie gactions push, aby skopiować lokalne pliki konfiguracji do projektu Actions.
git clone https://github.com/my/repo.git
Cloning into 'repo'...
remote: Enumerating objects: 10, done.
remote: Counting objects: 100% (10/10), done.
remote: Compressing objects: 100% (9/9), done.
remote: Total 51 (delta 3), reused 3 (delta 1), pack-reused 41
Receiving objects: 100% (51/51), 36.86 KiB | 3.69 MiB/s, done.
Resolving deltas: 100% (11/11), done.
cd repo/sdk/
vi settings/settings.yaml
// change the value of `projectId`
gactions push

Wersje strony aplikacji

Uruchom polecenie gactions versions list, aby wyświetlić szczegółowe informacje o wersjach akcji. Więcej informacji o stanach wersji znajdziesz w dokumentacji dotyczącej stanu.

gactions versions list
Version         Status          Last Modified By        Modified On     
1           Created     your-email@your-domain.com  2020-09-28 20:22:04

Jeśli stan wdrożenia to „Nie udało się utworzyć”, w sekcji „Wersja” w konsoli znajdziesz więcej informacji na ten temat.

Wdrażanie projektów

Polecenie gactions deploy umożliwia wdrożenie projektu do przetestowania w Symulatorze Actions lub w kanale wersji alfa, beta lub produkcyjnej.

Wyświetl podgląd w symulatorze

Uruchom gactions deploy preview, aby wdrożyć akcję w trybie „preview” (podgląd), co umożliwia testowanie jej w konsoli bez aktualizowania wersji projektu Action ani wpływać na innych deweloperów. Oznacza to, że żadne zmiany wprowadzone w lokalnym systemie plików nie są propagowane do wdrożonych wersji projektu Actions, ale są dostępne do przetestowania w wersji testowej.

gactions deploy preview
Deploying your project files to your Actions console preview for a project id: "my-project". This may take a few minutes.
Sending configuration files
Waiting for server to respond.
✔ Done. You can now navigate to the Actions Console simulator to test your changes: http://console.actions.google.com/project/my-project/simulator?disableAutoPreview

Tworzenie wersji

Uruchom gactions deploy, aby utworzyć wersje dla kanałów alfa, beta i produkcyjnego, którymi możesz zarządzać w sekcji Wdróż w konsoli Actions. Pozwala przetestować kandydatury do wersji akcji w kanałach alfa lub beta. Jeśli opinie będą zadowalające, przenieś daną wersję do wersji produkcyjnej.

gactions deploy alpha
Deploying your project files to a actions.channels.Alpha channel for a project id: "my-project-id"
Sending configuration files
Waiting for server to respond.
✔ Done. Your Action was deployed to actions.channels.Alpha channel. You can check status of deployment in the Actions Console.

Kanały wersji strony aplikacji

Uruchom gactions release-channels list, aby wyświetlić szczegóły kanałów wersji dla akcji. Za pomocą tego polecenia możesz zidentyfikować wersję wdrożoną lub oczekującą w każdym kanale.

gactions release-channels list
Release Channel             Current Version             Pending Version
alpha                   1                     N/A

Łączenie kont

Polecenia gactions encrypt i gactions decrypt umożliwiają administrowanie tajnymi kluczami klienta OAuth2. Te polecenia dotyczą tylko łączenia kont.

Szyfruj tajne klucze klienta dotyczące łączenia kont OAuth2

Uruchom gactions encrypt, aby bezpiecznie dodać obiekty tajne klienta na potrzeby procesów łączenia kont OAuth2 kodu autoryzacji lub zaszyfrować istniejące obiekty tajne za pomocą nowego klucza szyfrowania.

gactions encrypt
Write your secret: *********************
Encrypting your client secret
path/to/myAction/sdk/settings/accountLinkingSecret.yaml already exists. Would you like to overwrite it?. [y/n]
y
✔ Done. Encrypted secret was written to path/to/myAction/sdk/settings/accountLinkingSecret.yaml

Dostęp w postaci zwykłego tekstu do wartości zaszyfrowanych obiektów tajnych łączenia kont.

Jeśli chcesz tymczasowo uzyskać dostęp do wartości w postaci zwykłego tekstu w obiekcie tajnym projektu, uruchom gactions decrypt. Polecenie wyświetli wartość w wybranym przez Ciebie pliku tekstowym. Zalecamy, aby plik docelowy znajdował się poza folderem głównym projektu, aby uniknąć przypadkowego wycieku wartości zwykłego tekstu.

gactions decrypt ../../burn_after_read.txt
Decrypting your client secret
✔ Done. Check path/above/myActions/burn_after_read.txt to find decrypted client secret.
vi ../../burn_after_read.txt
rm ../../burn_after_read.txt