AdvancedInstaller - przygotowanie paczki MSI za darmo

Spis treści

Wstęp

Ostatnimi czas stanąłem znów przed zadaniem utworzenia instalatora dla prostego programu okienkowego na Windows. Poprzedni wykonałem za pomocą technologi WiX, jednak jego ograniczenia takie jak: wymaganie budowania przez msbuild, brak sensownego kreatora, czy mnóstwo problemów przy automatycznym wykrywaniu plików, które powinny znaleźć się wewnątrz paczki, zachęciły mnie do poszukiwania rozwiązania, które jest zdecydowanie łatwiejsze w obsłudze.

Tak natrafiłem na Advanced Installer, który nie ma tych niedogodności. Jedno, co muszę wymienić, to, że w wersji darmowej nie ma możliwości robienia "pakietów". Nie możesz tutaj dorzucić paczek zawierających wymagane przez twoją Aplikacje SDK, czy pakiety redystrybucyjne. Jeśli jest to twoim wymaganiem, to niestety nie tutaj.

Warto zwrócić uwagę, że licencja jasno wskazuje, że darmowa wersja Advanced Installer może być używana komercyjnie:

2.1 Freeware Features License. Caphyon grants you an unlimited license to use the Freeware Features of the Software. The install packages created using only the Freeware Features can be freely redistributed and used both in commercial and non-commercial purpose.

— Advanced Installer End User Licence
https://www.advancedinstaller.com/eula.html

Przygotowanie lokalnego środowiska

Przygotowanie lokalnego środowiska zacznijmy od pobrania instalatora z strony producenta. Zainstaluj go, a następnie uruchom.

Tabela 1. Instalacja Advanced Installer
Ilustracja 1. Pobieranie	Ilustracja 2. Instalacja	Ilustracja 3. Gotowy program

Następnie pobierz i zainstaluj wtyczkę do Visual Studio. Znajdziesz ją tutaj. Pamiętaj, aby ściągnąć wersję odpowiednią dla twojego środowiska.

Tabela 2. Instalacja dodatku do Visual Studio 2022
Ilustracja 4. Pobieranie	Ilustracja 5. Instalacja

Przygotowanie projektu:

Mając odpowiednio przygotowane środowisko, możemy przejść do konkretów:

Przykładowy projekt WPF,

Dla celów demonstracyjnych utwórzmy nowy projekt WPF (1) w Visualu o nazwie AdvancedInstallerDemo.Wpf (2). Dla pewności sprawdź, czy program poprawnie się uruchamia, aby nie było później niejasności.

Tabela 3. Tworzenie nowego projektu
Ilustracja 6. Wybierz projekt WPF,	Ilustracja 7. Nadaj mu nazwę,	Ilustracja 8. Sprawdź, czy działa!

Dodanie projektu instalatora

Teraz najważniejsze, dodajemy instalator!

W tym celu utwórz nowy projekt Advanced Installer Project za pomocą Visual studio o nazwie AdvancedInstallerDemo.Installer i kliknij dwukrotnie nowo utworzony projekt, otworzy się okno ze wtyczką. Następnie przejdź do "Files and Folders" (1), i kliknij przycisk "Add Project Output" (2).
Otworzy się nowe okno, w którym zaznacz "Publish Profile" przy projekcie WPF. Jeśli nie tworzyłeś wcześniej profilu publikacji, to w tym momencie zostaniesz o to poproszony. Do działania jest potrzebny profil publikacji do Folderu, także wybierz pozycję "Folder" i przejdź kreator z domyślnymi wartościami (zwróć uwagę, aby nie wybrać ClickOnce!).
Teraz możesz wrócić do projektu instalatora, przejść do "Files and Folder", kliknąć "Add Project Output" i upewnić się, że odpowiedni profil publikacji został wybrany.
Przebuduj projekt instalatora (PPM na projekt i wybierz pozycję Rebuild).
Przejdź do katalogu projektu instalatora, następnie do folderu AdvancedInstallerDemo.Installer-SetupFiles. Wewnątrz znajdziesz plik AdvancedInstallerDemo.Installer.msi! Twój instalator jest już gotowy do pracy.

Tabela 4. Dodawanie instalatora
Ilustracja 9. Dodaj projekt instalatora	Ilustracja 10. Dodaj pliki projektu	Ilustracja 11. Dodaj wyjście projektu WPF
Ilustracja 12. Utwórz profil publikacji (1)	Ilustracja 13. Utwórz profil publikacji (2)	Ilustracja 14. Upewnij się, że wybrany został profil

Podstawowa konfiguracja

Niestety, to nie wszystko. Aby móc korzystać z wielu udogodnień, musimy wykonać jeszcze kilka kroków.

Jeśli zainstalowałeś swoją paczkę, to zapewne zauważyłeś, że twoja aplikacja instaluje się w dziwnym katalogu, jakim jest C:\Program Files(x86)\Your Company\Your Application. Aby to zmienić, najlepiej uzupełnić kilka podstawowych informacji na temat twojej aplikacji.

Wróć do Visual Studio i projektu AdvancedInstallerDemo.Installer, wybierz plik z rozszerzeniem *.aip.
W zakładce "Product Details" uzupełnij pola "Product Name" nazwą twojej aplikacji, na przykład "Advanced Installer Demo". W polu "Company Name" wpisz nazwę organizacji, do której należy aplikacji, na przykład "Zaprogramuj to raz".

Zachęcam do wypełnienia pozostałych pól w tej zakładce, jednak nie będę ich tutaj omawiał. Pamiętaj, że po wybraniu konkretnego pola, u dołu okna pojawia się krótki opis, do czego ono służy. Jeśli i ta wiedza nie będzie wystarczająca, masz do dyspozycji jeszcze przycisk pomocy — znak zapytania w niebieskim okręgu w górnym prawym rogu okna.

Pamiętaj, że jeszcze więcej ciekawych funkcji jest dostępnych pod przyciskiem "Edit in Advanced Installer" w lewej dolnej krawędzi okna.

Dodawanie skrótu na pulpicie

Skrót na pulpicie można dodać w dedykowanej aplikacji Advanced Installer. By to zrobić, kliknij niebieski przycisk "Edit in Advanced Installer" w Visual Studio, albo dwukrotnie na projekt instalatora w Eksploratorze Plików.

Przejdź do zakładki "Shortcuts", następnie kliknij prawym przyciskiem myszki i wybierz "Installed File" (1).
Następnie przejdź do katalogu, gdzie jest zainstalowana aplikacja, wybierz główny plik wykonawczy (2) i kliknij ok.
Następnie w oknie właściwości, przy polu "Shortcut folder" kliknij przycisk z trzema kropkami (3) i wybierz katalog "Desktop" (4) i kliknij Ok (5).

Teraz, przy następnej instalacji skrót pojawi sie na pulpicie!

Tabela 5. Ustawienie skrótu do aplikacji na pulpicie

Zapewnienie łatwej aktualizacji pakietu (zmiana wersji)

Jednym z wymagań stawianych wobec instalatora jest aktualizacja aplikacji. Kluczowym elementem jest zwiększanie numeru wersji. Bez tego próba instalacji zakończy się błędem. Aby instalator mógł aktualizować aplikację, konieczna jest zmiana wersji. Dlaczego przeczytasz tutaj i tutaj.

Numer wersji możemy zmienić na dwa sposoby:

W Visual studio

W zakładce "Product Details" w polu "Product Version" możesz zmienić wersję.

Z konsoli

Wykonując dwa następne polecenia, zmienisz tymczasowo plik projektu instalatora i zbudujesz go z tymi ustawieniami. Pamiętaj, aby poniższe polecenia wykonać w katalogu, gdzie znajduje się projekt instalatora!

& "C:\Program Files (x86)\Caphyon\Advanced Installer 19.4\bin\x86\AdvancedInstaller.com" /Edit .\AdvancedInstallerDemo.Installer.aip /SetVersion 1.3.0
& "C:\Program Files (x86)\Caphyon\Advanced Installer 19.4\bin\x86\AdvancedInstaller.com" /Rebuild .\AdvancedInstallerDemo.Installer.aip

Ścieżka instalacji nie zostanie zmieniona, w przypadku, gdy zaktualizowaliśmy pola "Company Name" oraz "Product Name". Ścieżka instalacji zostanie zmieniona dopiero po ponownej instalacji.

Cicha instalacja

Uwaga

Podczas cichej instalacji zauważony został pewien błąd. Otóż, jeśli instalacja się nie powiedzie, to nie otrzymasz żadnego błędu! Aby temu zapobiec, należy uruchomić instalację ze skryptu PowerShell:

Pobieranie kodu błędu z instalatora. Kod należy umieścić w jednym pliku *.ps1

& '.\AdvancedInstallerDemo.Installer.msi' /qn
if( ($LASTEXITCODE -ne 0) -and -not ( $LASTEXITCODE -eq $null) ) {
	throw "Exit code is $LASTEXITCODE"
}

Dużą zaletą poprawnie przygotowanych instalatorów MSI jest możliwość ich instalacji z konsoli, bez interakcji z człowiekiem. Taką funkcjonalność nazywamy trybem cichym, co pozwala na wykorzystanie go w automatyzacji, czy grupach GPO. Aby dowiedzieć się więcej, zajrzyj do dokumentacji. Cichą instalację, wykonuje się poniższym poleceniem.

Pamiętaj, aby uruchamiać instalację jako administrator, jeśli aplikacja ma trafić do katalogu Program Files.

 '.\AdvancedInstallerDemo.Installer 1.3.0.msi' /quiet

Pamiętaj, że instalacja w katalogu Program Files wymaga uprawnień administratora. Jeśli twoja aplikacja nie instaluje się poprawnie w trybie cichym, upewnij się, że uruchamiasz polecenie z odpowiednimi uprawnieniami!

Dodatek: TeamCity

Ta sekcja jest dodatkiem, ponieważ jest ona przeznaczona dla osób, które mają minimalne obeznanie z TeamCity. Pokazuję tutaj jak dodać krok, który zbuduje nam instalator, bez opisu całej procedury tworzenia projektu.

Pobieranie i instalacja pluginu na TeamCity.

Instalacja dodatku pozwala nam na proste tworzenie kroku budującego instalator oraz dodanie narzędzia, które będzie automatycznie instalowane na każdym agencie budującym. Jest to bardzo wygodne, ponieważ nie musimy pilnować, czy nasz budujący znajduje się wszędzie tam, gdzie będzie potrzebny.

Pobierz dodatek z GitHub’a https://github.com/Caphyon/teamcity-advinst-build-runner, wydania dostępne są w sekcji Releases. Najnowsze wydanie jest w wersji 1.3 dostępne bezpośrednio pod tym adresem
Na TeamCity udaj się do zakładki Administrations (1) > Plugins (2) i kliknij "Upload plugin zip" (3), wybierz pobrany plik .zip (4) i załaduj go klikając ponownie przycisk "Upload plugin zip" (5).
Następnie włącz plugin klikając "Enable uploaded plugins" i znów "Enable".
Teraz przjdź do zakładki Tools (6) (również wewnątrz Administration), następnie wybierz "Install Tool…" (7), wybierz "Advanced Installer" (7) i kliknij "Add" (8).
W tym momencie, jeśli na serwerze budującym nie został zainstlowany Advanced Installer, masz możliwość to źrobić. Wybierz najnowszą wersję i kliknij "Add".
Po chwili oczekiwania narzędzie jest gotowe do działania.

Tabela 6. Instalacja dodatku do TeamCity
Ilustracja 15. Instalowanie wtyczki	Ilustracja 16. Instalowanie narzędzia

Przykładowe wypełnienie kroku budowania.

Ilustracja 17. Przykładowy krok budowania instalatora na TeamCity

Przejdź do projektu, do którego chcesz dodać budowanie instalatora,
Kliknij "Add build step",
Wybierz "Runner type" jako Advanced Installer.
Następnie podaj ścieżkę do pliku projektu instalatora. Dla projektu utworzonego wcześniej byłoby to: AdvancedInstallerDemo.Installer/AdvancedInstallerDemo.Installer.aip.
Następnie musisz okreslić wartość "AIP Build". Domyślnie jest to DefaultBuild. Tę wartość znajdziesz w narzędziu Advanced Installer (nie pomyl z pluginem do Visual Studio) w zakładce "Builds".
Teraz możesz określić nazwę pliku wynikowego. Ja lubię dodawać do instalatora numer wersji, na przykład: AIDemoInstaller-%build.number%.msi. Pamiętaj, aby wcześniej określić poprawny numer wersji ^[1] w zakładce "General Settings". Jeśli nie widzisz pola "Build number format", to kliknij "Show advanced options" ponizej formularza.
Możesz dodatkowo określić katalog wyjściowy (Output Folder)
I najważniejsze, powinieneś okerślić transformacje wykonywane na pliku projektu przed wykonaniem budowania. Najwazniejsza jest zmiana nazwy, dlatego w pole "Commands" polecam wpisać Ci:

SetVersion %build.number%
Save

Wstęp i bardziej szczegółowy opis pliku poleceń znajdziesz tutaj.

Zdjęcie tytułowe by Zan.

1. Z opisu w oknie pluginu Visual Studio jest napisane, że numer wersji powinien wyglądać tak: "x.y.z", gdzie x, y i z są liczbami całkowitymi. Największa możliwa wartość to 255.255.65535.65535. Inne przykładowe, poprawne formaty, to: "3", "2.0", "2.11", "5.10.5". Opis ten pochodzi z pluginu do Visual Studio w wersji 19.4.