Spis treści
W tym artykule nie będę szczegółowo opisywał kwestii tworzenia akcji Github. Niemniej chciałbym, aby było to miejsce, w którym można zacząć swoją przygodę, dlatego poniższe wskazówki nadają się do każdego typu projektu, który zakłada publikowanie nugeta. W tym momencie zakładam, że masz już gotowe repozytorium na Githubie – ten artykuł nie będzie pokrywał wypychania swoich zmian na zdalne repozytorium.
Aby móc publikować w repozytorium nuget.org musimy najpierw założyć konto i utworzyć klucz API
W tym celu udaj się na stronę Nuget.org – możesz się tam zalogować nawet za pomocą konta Microsoft
Następnie przejdź do strony z kluczami API
Po zalogowaniu wybierz nazwę swojego konta a stamtąd API Keys.
Potem utwórz nowy klucz API
-
Wprowadź nazwę klucza w polu Key Name, która będzie określać, gdzie użyłeś danego klucza. Ja użyłem nazwy ZtrTemplates.
-
Wprowadź wzorzec, który określi jakie pakiety mogą być publikowane za pomocą tego klucza, np.
ZTR.*. -
Wybierz Create.
-
Od razu po utworzeniu skopiuj klucz i tymczasowo nie zamykaj karty. W ostrzeżeniu jest wyraźnie napisane, że po zamknięciu tej karty ponowne uzyskanie klucza nie będzie możliwe.
Dodaj klucz API do swojego repozytorium
-
W tym celu udaj się do ustawień repozytorium, gdzie następnie przejdź do Actions i wybierz New repository secret.
-
Następnie podaj nazwę klucza – postaraj się nie zrobić w niej błędu, będziemy jej później używać. W moim przypadku użyłem nazwy
NUGET_API_KEY, i wklej klucz API skopiowany z nuget.org.
Następnym krokiem jest utworzenie akcji w naszym repozytorium
Najprościej jest to zrobić, udając się na stronę Actions a następnie wybierając set up a workflow yourself.
Następnie wklej w akcję poniższy kod i zatwierdź wszystko na swojej gałęzi:
name: Publikuj szablon do Nuget.org
on:
push:
branches: [ main ] (1)
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup .NET
uses: actions/setup-dotnet@v1
with:
dotnet-version: 5.0.x
- name: Restore dependencies
run: dotnet restore
- name: Build
run: dotnet build --no-restore
- name: Test
run: dotnet test --no-build --verbosity normal
- name: Pack
run: dotnet pack --no-build --configuration Release
- name: Publish to nuget.org
run: dotnet nuget push "./bin/Release/*.nupkg" -k ${{ secrets.NUGET_API_KEY }} -s https://api.nuget.org/v3/index.json --skip-duplicate (2)| 1 | W tym miejscu określamy, że chcemy, aby nasza akcja byłą wykonywana tylko wtedy, gdy pojawią się nowe zatwierdzenia (z ang. commits) na gałęzi main. |
| 2 | To jest serce całej akcji, publikujemy wszystkie paczki nuget znajdujace się w katalogu ./bin/Release.
Domyślnie będzie znajdowała się tam tylko nasza paczka, więc taka konstrukcja chroni nas przed zmianą nazwy w przyszłości.
Do tego w miejscu -k ${{ secrets.NUGET_API_KEY }} przekazujemy nasz token do Nuget.org utworzony wcześniej. |
Dodatkowo warto pochylić się jeszcze nad:
-
-s https://api.nuget.org/v3/index.json– podanie adresu, gdzie chcemy publikować, jest wymagane w poleceniu, chyba, że wartość ta została zdefiniowana osobno w pliku projektu (więcej informacji w dokumentacji) -
--skip-duplicate– powoduje, że próba wypchnięcia tego samego pakietu (o tej samej wersji) zostanie pominięta a cała akcja zakończy się pozytywnie (bez zwracania kodu błędu).
Kod, który widzisz poniżej jest zbitkiem elementów z repozytorium setup-dotnet oraz dokumentacji dotnet nuget push.
Poczekaj chwilę i sprawdź, czy jest już aktualizacja.
Jeśli tak, to aktualizuj!
Dla przypomnienia szablon możesz zainstalować w następujący sposób – zostanie on automatycznie pobrany z witryny Nuget.org.
dotnet new --install ZTR.Utilities.TemplatesNastępnie możesz sprawdzić możliwe aktualizacje i je zastosować za pomocą dwóch poniższych poleceń:
PS C:\Users\dalec> dotnet new --update-check
Dostępne są aktualizacje dla następujących elementów:
Dostępna jest aktualizacja pakietu szablonów ZTR.Utilities.Templates::1.0.0.
polecenie instalowania: dotnet new -i ZTR.Utilities.Templates::1.1.0
PS C:\Users\dalec> dotnet new --update-apply
Dostępna jest aktualizacja pakietu szablonów ZTR.Utilities.Templates::1.0.0.
polecenie instalowania: dotnet new -i ZTR.Utilities.Templates::1.1.0
Trwa aktualizowanie...
...Aktualizacja powiodła się.Zawsze możesz podejrzeć zainstlowaną wersję za pomocą polecenia dotnet new -u.
PS C:\Users\dalec> dotnet new -u
ZTR.Utilities.Templates
Szczegóły:
NuGetPackageId: ZTR.Utilities.Templates
Version: 1.1.0
Author: Zaprogramuj to raz!Po wypchnięciu swojej paczki trzeba chwilę poczekać zanim przejdzie ona przez proces weryfikacji. Kiedy wszystko pójdzie dobrze możesz zobaczyć na stronie paczki takie coś:
Gotowe! Nie ma to jak automatyzacja, która zwalnia nas z robienia rzeczy, które w sumie nie wnoszą żadnej wartości do naszej pracy.