Skip to content

Commit 9a3130e

Browse files
author
kuiper
committed
Version 1.7.0
1 parent ae3714b commit 9a3130e

16 files changed

+165
-77
lines changed

‎CHANGES‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1+
+ VERSION 1.7.0; 2023-10-25
2+
- Feature #24: Automatically skips confirmation if environment variable "CI=true" is defined.
3+
- Other minor tweaks.
4+
5+
16
+ VERSION 1.6.0; 2023-07-22
27
- IMPORTANT: RPM now creates output file directly under output directory, rather than under "RPMS/arch" sub-directory.
38
- Bugfix #21: Inno Setup fails with x86 (dotnet runtime "win-x32")
49
- Bugfix #23: AppImage desktop file broken (macros ${INSTALL_BIN} and ${INSTALL_EXEC} now have leading forward slash for AppImage)
510

11+
612
+ VERSION 1.5.0; 2023-05-07
713
- Added ability to parse list items in 'AppDescription' configuration and transpose to HTML.
814
- Added XML validation of AppStream metadata (will now warn if invalid prior to build).
@@ -14,6 +20,7 @@
1420
- Ships with: appimagetool 13 (2020-12-31)
1521
- Tested against: rpmbuild RPM version 4.18.1, dpkg 1.21.21, flatpak-builder 1.2.3, InnoSetup 6.2.2
1622

23+
1724
+ VERSION 1.4.1; 2023-05-06
1825
- Bugfix #16: AppImage and Flatpak builds rejected AppStream metadata if conf.AppDescription was empty. Now defaults to AppShortSummary.
1926
- Bugfix #15: AppImage and Flatpak builds rejected AppStream metadata if conf.AppChangeFileEmpty.
@@ -23,20 +30,18 @@
2330
- Ships with: appimagetool 13 (2020-12-31)
2431
- Tested against: rpmbuild RPM version 4.18.1, dpkg 1.21.21, flatpak-builder 1.2.3, InnoSetup 6.2.2
2532

26-
+ VERSION 1.4.0; 2023-05-05
2733

34+
+ VERSION 1.4.0; 2023-05-05
2835
- Added 'AppDescription' property to configuration (IMPORTANT NEW FEATURE - see website for information)
2936
- Added ${APPSTREAM_DESCRIPTION_XML} macro to support release information in AppStream metadata
3037
- Updated AppStream metadata template to include ${APPSTREAM_CHANGELOG_XML}
3138
- Now uses 'AppDescription' content when building both RPM and DEB packages
32-
3339
- Added 'AppChangeFile' property to configuration (IMPORTANT NEW FEATURE - see website for information)
3440
- Added ${APPSTREAM_CHANGELOG_XML} macro to support release information in AppStream metadata
3541
- Updated AppStream metadata template to include ${APPSTREAM_DESCRIPTION_XML}
3642
- The AppChangeFile file is now packaged verbatim to the bin directory of deployments
3743
- Added 'InfoBeforeFile' to Windows Setup in order to show AppChangeFile file content
3844
- Added CHANGELOG section to console output when building a package (contains parsed changes only)
39-
4045
- Added MACRO section (verbose only) to console output when building a package (useful for debugging)
4146
- Extensive updates to README documentation
4247
- Other minor corrections and changes

‎PupNet.Test/ConfigurationReaderTest.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ public void SetupMinWindowsVersion_Mandatory_DecodeOK()
323323
[Fact]
324324
public void SetupSignTool_Optional_DecodeOK()
325325
{
326-
Assert.Equal("signtool.exe", Create().SetupSignTool);
326+
Assert.Equal(DummyConf.ExpectSignTool, Create().SetupSignTool);
327327
Assert.Null(Create(nameof(ConfigurationReader.SetupSignTool)).SetupSignTool);
328328
}
329329

‎PupNet.Test/DummyConf.cs‎

Lines changed: 56 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ namespace KuiperZone.PupNet.Test;
2424
/// </summary>
2525
public class DummyConf : ConfigurationReader
2626
{
27+
public const string ExpectSignTool =
28+
"\"C:/Program Files (x86)/Windows Kits/10/bin/10.0.22621.0/x64/signtool.exe\" sign /f \"{#GetEnv('SigningCertificate')}\" /p \"{#GetEnv('SigningCertificatePassword')}\" /tr http://timestamp.sectigo.com /td sha256 /fd sha256 $f";
29+
2730
public DummyConf()
2831
: base(new ArgumentReader(), Create())
2932
{
@@ -48,59 +51,59 @@ private static string[] Create(string? omit = null)
4851
var lines = new List<string>();
4952

5053
// Quote variations
51-
lines.Add($"{nameof(ConfigurationReader.AppBaseName)} = 'HelloWorld'");
52-
lines.Add($"{nameof(ConfigurationReader.AppFriendlyName)} = Hello World");
53-
lines.Add($"{nameof(ConfigurationReader.AppId)} = \"net.example.helloworld\"");
54-
lines.Add($"{nameof(ConfigurationReader.AppVersionRelease)} = 5.4.3[2]");
55-
lines.Add($"{nameof(ConfigurationReader.PackageName)} = HelloWorld");
56-
lines.Add($"{nameof(ConfigurationReader.AppShortSummary)} = Test <application> only");
57-
lines.Add($"{nameof(ConfigurationReader.AppDescription)} = \n Para1-Line1\n<Para1-Line2>\n\n- Bullet1\n* Bullet2\nPara2-Line1 has ${{MACRO_VAR}}\n");
58-
lines.Add($"{nameof(ConfigurationReader.AppLicenseId)} = LicenseRef-LICENSE");
59-
lines.Add($"{nameof(ConfigurationReader.AppLicenseFile)} = LICENSE");
60-
lines.Add($"{nameof(ConfigurationReader.AppChangeFile)} = CHANGELOG");
61-
62-
lines.Add($"{nameof(ConfigurationReader.PublisherName)} = Kuiper Zone");
63-
lines.Add($"{nameof(ConfigurationReader.PublisherCopyright)} = Copyright Kuiper Zone");
64-
lines.Add($"{nameof(ConfigurationReader.PublisherLinkName)} = kuiper.zone");
65-
lines.Add($"{nameof(ConfigurationReader.PublisherLinkUrl)} = https://kuiper.zone");
66-
lines.Add($"{nameof(ConfigurationReader.PublisherEmail)} = [email protected]");
67-
68-
lines.Add($"{nameof(ConfigurationReader.StartCommand)} = helloworld");
69-
lines.Add($"{nameof(ConfigurationReader.DesktopNoDisplay)} = TRUE");
70-
lines.Add($"{nameof(ConfigurationReader.DesktopTerminal)} = False");
71-
lines.Add($"{nameof(ConfigurationReader.PrimeCategory)} = Development");
72-
lines.Add($"{nameof(ConfigurationReader.DesktopFile)} = app.desktop");
73-
lines.Add($"{nameof(ConfigurationReader.IconFiles)} = Assets/Icon.32x32.png; Assets/Icon.x48.png; Assets/Icon.64.png; Assets/Icon.ico; Assets/Icon.svg;");
74-
lines.Add($"{nameof(ConfigurationReader.MetaFile)} = metainfo.xml");
75-
76-
lines.Add($"{nameof(ConfigurationReader.DotnetProjectPath)} = HelloProject");
77-
lines.Add($"{nameof(ConfigurationReader.DotnetPublishArgs)} = --self-contained true");
78-
lines.Add($"{nameof(ConfigurationReader.DotnetPostPublish)} = PostPublishCommand.sh");
79-
lines.Add($"{nameof(ConfigurationReader.DotnetPostPublishOnWindows)} = PostPublishCommandOnWindows.bat");
80-
81-
lines.Add($"{nameof(ConfigurationReader.OutputDirectory)} = Deploy");
82-
83-
lines.Add($"{nameof(ConfigurationReader.AppImageArgs)} = -appargs");
84-
lines.Add($"{nameof(ConfigurationReader.AppImageVersionOutput)} = true");
85-
86-
lines.Add($"{nameof(ConfigurationReader.FlatpakPlatformRuntime)} = org.freedesktop.Platform");
87-
lines.Add($"{nameof(ConfigurationReader.FlatpakPlatformSdk)} = org.freedesktop.Sdk");
88-
lines.Add($"{nameof(ConfigurationReader.FlatpakPlatformVersion)} = \"18.00\"");
89-
lines.Add($"{nameof(ConfigurationReader.FlatpakFinishArgs)} = --socket=wayland;--socket=fallback-x11;--filesystem=host;--share=network");
90-
lines.Add($"{nameof(ConfigurationReader.FlatpakBuilderArgs)} = -flatargs");
91-
92-
lines.Add($"{nameof(ConfigurationReader.RpmAutoReq)} = true");
93-
lines.Add($"{nameof(ConfigurationReader.RpmAutoProv)} = false");
94-
lines.Add($"{nameof(ConfigurationReader.RpmRequires)} = rpm-requires1;rpm-requires2");
95-
96-
lines.Add($"{nameof(ConfigurationReader.DebianRecommends)} = deb-depends1;deb-depends2");
97-
98-
lines.Add($"{nameof(ConfigurationReader.SetupAdminInstall)} = true");
99-
lines.Add($"{nameof(ConfigurationReader.SetupCommandPrompt)} = Command Prompt");
100-
lines.Add($"{nameof(ConfigurationReader.SetupMinWindowsVersion)} = 6.9");
101-
lines.Add($"{nameof(ConfigurationReader.SetupSignTool)} = signtool.exe");
102-
lines.Add($"{nameof(ConfigurationReader.SetupSuffixOutput)} = Setup");
103-
lines.Add($"{nameof(ConfigurationReader.SetupVersionOutput)} = true");
54+
lines.Add($"{nameof(AppBaseName)} = 'HelloWorld'");
55+
lines.Add($"{nameof(AppFriendlyName)} = Hello World");
56+
lines.Add($"{nameof(AppId)} = \"net.example.helloworld\"");
57+
lines.Add($"{nameof(AppVersionRelease)} = 5.4.3[2]");
58+
lines.Add($"{nameof(PackageName)} = HelloWorld");
59+
lines.Add($"{nameof(AppShortSummary)} = Test <application> only");
60+
lines.Add($"{nameof(AppDescription)} = \n Para1-Line1\n<Para1-Line2>\n\n- Bullet1\n* Bullet2\nPara2-Line1 has ${{MACRO_VAR}}\n");
61+
lines.Add($"{nameof(AppLicenseId)} = LicenseRef-LICENSE");
62+
lines.Add($"{nameof(AppLicenseFile)} = LICENSE");
63+
lines.Add($"{nameof(AppChangeFile)} = CHANGELOG");
64+
65+
lines.Add($"{nameof(PublisherName)} = Kuiper Zone");
66+
lines.Add($"{nameof(PublisherCopyright)} = Copyright Kuiper Zone");
67+
lines.Add($"{nameof(PublisherLinkName)} = kuiper.zone");
68+
lines.Add($"{nameof(PublisherLinkUrl)} = https://kuiper.zone");
69+
lines.Add($"{nameof(PublisherEmail)} = [email protected]");
70+
71+
lines.Add($"{nameof(StartCommand)} = helloworld");
72+
lines.Add($"{nameof(DesktopNoDisplay)} = TRUE");
73+
lines.Add($"{nameof(DesktopTerminal)} = False");
74+
lines.Add($"{nameof(PrimeCategory)} = Development");
75+
lines.Add($"{nameof(DesktopFile)} = app.desktop");
76+
lines.Add($"{nameof(IconFiles)} = Assets/Icon.32x32.png; Assets/Icon.x48.png; Assets/Icon.64.png; Assets/Icon.ico; Assets/Icon.svg;");
77+
lines.Add($"{nameof(MetaFile)} = metainfo.xml");
78+
79+
lines.Add($"{nameof(DotnetProjectPath)} = HelloProject");
80+
lines.Add($"{nameof(DotnetPublishArgs)} = --self-contained true");
81+
lines.Add($"{nameof(DotnetPostPublish)} = PostPublishCommand.sh");
82+
lines.Add($"{nameof(DotnetPostPublishOnWindows)} = PostPublishCommandOnWindows.bat");
83+
84+
lines.Add($"{nameof(OutputDirectory)} = Deploy");
85+
86+
lines.Add($"{nameof(AppImageArgs)} = -appargs");
87+
lines.Add($"{nameof(AppImageVersionOutput)} = true");
88+
89+
lines.Add($"{nameof(FlatpakPlatformRuntime)} = org.freedesktop.Platform");
90+
lines.Add($"{nameof(FlatpakPlatformSdk)} = org.freedesktop.Sdk");
91+
lines.Add($"{nameof(FlatpakPlatformVersion)} = \"18.00\"");
92+
lines.Add($"{nameof(FlatpakFinishArgs)} = --socket=wayland;--socket=fallback-x11;--filesystem=host;--share=network");
93+
lines.Add($"{nameof(FlatpakBuilderArgs)} = -flatargs");
94+
95+
lines.Add($"{nameof(RpmAutoReq)} = true");
96+
lines.Add($"{nameof(RpmAutoProv)} = false");
97+
lines.Add($"{nameof(RpmRequires)} = rpm-requires1;rpm-requires2");
98+
99+
lines.Add($"{nameof(DebianRecommends)} = deb-depends1;deb-depends2");
100+
101+
lines.Add($"{nameof(SetupAdminInstall)} = true");
102+
lines.Add($"{nameof(SetupCommandPrompt)} = Command Prompt");
103+
lines.Add($"{nameof(SetupMinWindowsVersion)} = 6.9");
104+
lines.Add($"{nameof(SetupSignTool)} = {ExpectSignTool}");
105+
lines.Add($"{nameof(SetupSuffixOutput)} = Setup");
106+
lines.Add($"{nameof(SetupVersionOutput)} = true");
104107

105108
Remove(lines, omit);
106109

‎PupNet.Test/PupNet.Test.csproj‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222
</PackageReference>
2323
</ItemGroup>
2424

25+
<Target Name="CleanBinObj" AfterTargets="Clean">
26+
<RemoveDir Directories="$(ProjectDir)$(BaseOutputPath)" />
27+
<RemoveDir Directories="$(ProjectDir)$(BaseIntermediateOutputPath)" />
28+
</Target>
29+
2530
<ItemGroup>
2631
<ProjectReference Include="..\PupNet\PupNet.csproj" />
2732
</ItemGroup>

‎PupNet.pupnet.conf‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
AppBaseName = PupNet
55
AppFriendlyName = PupNet Deploy
66
AppId = zone.kuiper.pupnet
7-
AppVersionRelease = 1.6.0[1]
7+
AppVersionRelease = 1.7.0
88
AppShortSummary = Cross-platform deployment utility which packages your .NET project as a ready-to-ship installation file in a single step.
99
AppDescription = """
1010
PupNet Deploy is a cross-platform deployment utility which packages your .NET project as a ready-to-ship

‎PupNet/ArgumentParserExt.cs‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// -----------------------------------------------------------------------------
2+
// PROJECT : PupNet
3+
// COPYRIGHT : Andy Thomas (C) 2022-23
4+
// LICENSE : GPL-3.0-or-later
5+
// HOMEPAGE : https://github.com/kuiperzone/PupNet
6+
//
7+
// PupNet is free software: you can redistribute it and/or modify it under
8+
// the terms of the GNU Affero General Public License as published by the Free Software
9+
// Foundation, either version 3 of the License, or (at your option) any later version.
10+
//
11+
// PupNet is distributed in the hope that it will be useful, but WITHOUT
12+
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13+
// FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
14+
//
15+
// You should have received a copy of the GNU Affero General Public License along
16+
// with PupNet. If not, see <https://www.gnu.org/licenses/>.
17+
// -----------------------------------------------------------------------------
18+
19+
using System.Diagnostics.CodeAnalysis;
20+
using KuiperZone.Utility.Yaap;
21+
22+
namespace KuiperZone.PupNet;
23+
24+
/// <summary>
25+
/// Extensions for Yaap ArgumentParser 1.0.2.
26+
/// </summary>
27+
public static class ArgumentParserExt
28+
{
29+
[return: NotNullIfNotNull("def")]
30+
public static string? GetOrDefault(this ArgumentParser src, string? key, string? def)
31+
{
32+
return src[key] ?? def;
33+
}
34+
35+
[return: NotNullIfNotNull("def")]
36+
public static string? GetOrDefault(this ArgumentParser src, string key1, string key2, string? def)
37+
{
38+
return GetOrDefault(src, key1 ?? throw new ArgumentNullException(nameof(key1)),
39+
GetOrDefault(src, key2 ?? throw new ArgumentNullException(nameof(key2)), def));
40+
}
41+
42+
public static T GetOrDefault<T>(this ArgumentParser src, string key1, string key2, T def)
43+
where T : IConvertible
44+
{
45+
return src.GetOrDefault<T>(key1 ?? throw new ArgumentNullException(nameof(key1)),
46+
src.GetOrDefault<T>(key2 ?? throw new ArgumentNullException(nameof(key1)), def));
47+
}
48+
49+
}

‎PupNet/ArgumentReader.cs‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public class ArgumentReader
7474
public const string NewAllValue = "all";
7575
public const string NewAllowedSequence = $"conf|desktop|meta|all";
7676

77-
private string _string;
77+
private readonly string _string;
7878

7979
/// <summary>
8080
/// Default constructor. Values are defaults only.
@@ -119,7 +119,7 @@ public ArgumentReader(ArgumentParser args)
119119
Clean = args.GetOrDefault(CleanShortArg, CleanLongArg, false);
120120
IsVerbose = args.GetOrDefault(VerboseLongArg, false);
121121
IsUpgradeConf = args.GetOrDefault(UpgradeConfLongArg, false);
122-
IsSkipYes = args.GetOrDefault(SkipYesShortArg, SkipYesLongArg, false);
122+
IsSkipYes = args.GetOrDefault(SkipYesShortArg, SkipYesLongArg, false) || GetEnvironmentFlag("CI");
123123

124124
if (NewFile == null)
125125
{
@@ -206,7 +206,8 @@ public ArgumentReader(ArgumentParser args)
206206
public bool IsUpgradeConf { get; }
207207

208208
/// <summary>
209-
/// Gets whether to skip yes.
209+
/// Gets whether to skip yes. Also set to true if "CI" environment variable is true.
210+
/// See: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
210211
/// </summary>
211212
public bool IsSkipYes { get; }
212213

@@ -333,4 +334,16 @@ private static T AssertEnum<T>(string sname, string lname, string value) where T
333334
"Use one of: " + string.Join(',', Enum.GetValues<T>()));
334335
}
335336

337+
private static bool GetEnvironmentFlag(string name)
338+
{
339+
try
340+
{
341+
return name.Length != 0 && Environment.GetEnvironmentVariable(name)?.Equals("true", StringComparison.OrdinalIgnoreCase) == true;
342+
}
343+
catch
344+
{
345+
return false;
346+
}
347+
}
348+
336349
}

‎PupNet/BuildHost.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -454,13 +454,13 @@ private static IReadOnlyCollection<string> GetPublishCommands(PackageBuilder bui
454454

455455
if (!string.IsNullOrEmpty(pa))
456456
{
457-
sb.Append(" ");
457+
sb.Append(' ');
458458
sb.Append(pa);
459459
}
460460

461461
sb.Append(" -o \"");
462462
sb.Append(builder.BuildAppBin);
463-
sb.Append("\"");
463+
sb.Append('"');
464464

465465
list.Add(sb.ToString());
466466
}

‎PupNet/Builders/SetupBuilder.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ private string GetInnoFile()
204204

205205
if (!string.IsNullOrEmpty(Configuration.SetupSignTool))
206206
{
207+
// SetupSignTool = \"C:/Program Files (x86)/Windows Kits/10/bin/10.0.22621.0/x64/signtool.exe" sign /f "{#GetEnv('SigningCertificate')}" /p "{#GetEnv('SigningCertificatePassword')}" /tr http://timestamp.sectigo.com /td sha256 /fd sha256 $f
207208
sb.AppendLine($"SignTool={Configuration.SetupSignTool}");
208209
}
209210

‎PupNet/ChangeParser.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public ChangeParser(IEnumerable<string> content)
9696
continue;
9797
}
9898

99-
// Allow "+ description", but not "------"
99+
// Allow "- description", but not "------"
100100
if (line.StartsWith(ChangePrefix) && !line.StartsWith(new string(ChangePrefix, 2)))
101101
{
102102
// New change item
@@ -251,7 +251,8 @@ private static void AppendChange(List<ChangeItem> list, ref string? change)
251251
{
252252
const int MaxVersion = 25;
253253

254-
if (line.StartsWith(HeaderPrefix))
254+
// Allow "+ ", but not "++++"
255+
if (line.StartsWith(HeaderPrefix) && !line.StartsWith(new string(HeaderPrefix, 2)))
255256
{
256257
var items = line.Split(HeaderSeparator, StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries);
257258

0 commit comments

Comments
 (0)