From 91ff0d8c83b627e3724fd6dd73d947a7ecd412f5 Mon Sep 17 00:00:00 2001 From: Jason Alborough Date: Fri, 15 Jul 2022 14:06:00 -0400 Subject: [PATCH 01/16] nuspec-TEMPLATE fix: #17 changes nuspec to nuspec-TEMPALTE feature: adds brief configuration instructions for nuspec file to readme --- ... => PDT.EssentialsPluginTemplate.nuspec-TEMPLATE} | 0 README.md | 12 ++++++++++++ 2 files changed, 12 insertions(+) rename PDT.EssentialsPluginTemplate.EPI/{PDT.EssentialsPluginTemplate.nuspec => PDT.EssentialsPluginTemplate.nuspec-TEMPLATE} (100%) diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE similarity index 100% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec rename to PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE diff --git a/README.md b/README.md index 67a4614..8dfb905 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,15 @@ If you need a different version of PepperDash Core, use the command `nuget insta See the Task List in Visual Studio for a guide on how to start using the templage. There is extensive inline documentation and examples as well. For renaming instructions in particular, see the XML `remarks` tags on class definitions + +## Build Instructions (PepperDash Internal) + +## Generating Nuget Package + +In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec-TEMPLATE" + +1. Remove the -TEMPLATE so that the extention is .nuspec. +2. Rename the file to match your plugin solution name +3. Edit the file to include your project specifics including + 1. PepperDash.Essentials.Plugin.MakeModel Convention is to use the prefix "PepperDash.Essentials.Plugin" and include the MakeModel of the device. + 2. https://github.com/PepperDash/EssentialsPluginTemplate Change to your url to the project repo \ No newline at end of file From 0cf654ce2dbd7132ac85c94d4a2deaf651e0e393 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 16:42:25 -0500 Subject: [PATCH 02/16] Selective Nuget Package publish --- .../essentialsplugins-betabuilds.yml | 14 +- .../essentialsplugins-releasebuilds.yml | 19 +- GetPackages.BAT | 2 + ...T.EssentialsPluginTemplate.EPI.csproj.user | 5 - .../SIMPLSharpLogs/(2019-08-30 15-01-01).log | 63 --- .../EssentialsPluginTemplateBridgeJoinMap.cs | 6 +- .../EssentialsPluginTemplateConfigObject.cs | 388 +++++++++--------- .../EssentialsPluginTemplateCrestronDevice.cs | 2 +- .../EssentialsPluginTemplateDevice.cs | 6 +- .../EssentialsPluginTemplateFactory.cs | 16 +- .../EssentialsPluginTemplateLogicDevice.cs | 6 +- .../PDT.EssentialsPluginTemplate.EPI.csproj | 228 +++++----- .../PDT.EssentialsPluginTemplate.EPI.sln | 40 +- .../PDT.EssentialsPluginTemplate.nuspec | 4 +- .../Properties/AssemblyInfo.cs | 16 +- .../Properties/ControlSystem.cfg | 0 16 files changed, 382 insertions(+), 433 deletions(-) create mode 100644 GetPackages.BAT delete mode 100644 PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user delete mode 100644 PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log rename {PDT.EssentialsPluginTemplate.EPI => src}/EssentialsPluginTemplateBridgeJoinMap.cs (91%) rename {PDT.EssentialsPluginTemplate.EPI => src}/EssentialsPluginTemplateConfigObject.cs (94%) rename {PDT.EssentialsPluginTemplate.EPI => src}/EssentialsPluginTemplateCrestronDevice.cs (98%) rename {PDT.EssentialsPluginTemplate.EPI => src}/EssentialsPluginTemplateDevice.cs (97%) rename {PDT.EssentialsPluginTemplate.EPI => src}/EssentialsPluginTemplateFactory.cs (95%) rename {PDT.EssentialsPluginTemplate.EPI => src}/EssentialsPluginTemplateLogicDevice.cs (92%) rename {PDT.EssentialsPluginTemplate.EPI => src}/PDT.EssentialsPluginTemplate.EPI.csproj (98%) rename {PDT.EssentialsPluginTemplate.EPI => src}/PDT.EssentialsPluginTemplate.EPI.sln (97%) rename PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE => src/PDT.EssentialsPluginTemplate.nuspec (81%) rename {PDT.EssentialsPluginTemplate.EPI => src}/Properties/AssemblyInfo.cs (97%) rename {PDT.EssentialsPluginTemplate.EPI => src}/Properties/ControlSystem.cfg (100%) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index ad34045..8fcbbf8 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -222,6 +222,7 @@ jobs: Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 + env: NUSPECNAME steps: - name: Download Build Version Info uses: actions/download-artifact@v1 @@ -250,22 +251,27 @@ jobs: Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse + #Pushes to github nuget store - name: Get nuget File shell: powershell run: | - $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + $NUSPECNAME = Get-ChildItem *.nuspec -recurse + echo "NUSPEC_FILE=$($NUSPECNAME.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Add nuget.exe uses: nuget/setup-nuget@v1 - name: Add Github Packages source + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} - # Pushes to nuget, not needed unless publishing publicly + # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget push **/*.nupkg -source github - # Pushes to nuget, not needed unless publishing publicly >> this pushes package to nuget.org - name: Publish nuget package to nuget.org + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index 3e169ce..ff951dd 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -111,7 +111,7 @@ jobs: $exclusions = "packages" # Trying to get any .json schema files (not currently working) # Gets any files with the listed extensions. - Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz", "*.nuspec" | ForEach-Object { + Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz", "*.nuspec", "*.md" | ForEach-Object { $allowed = $true; # Exclude any files in submodules foreach ($exclude in $exclusions) { @@ -170,6 +170,7 @@ jobs: Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 + env: NUSPECNAME steps: - name: Download Build Version Info uses: actions/download-artifact@v1 @@ -195,25 +196,31 @@ jobs: Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory run: | - Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") + Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz","*.md") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse + # Pushes to github nuget store - name: Get nuget File shell: powershell run: | - $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + $NUSPECNAME = Get-ChildItem *.nuspec -recurse + echo "NUSPEC_FILE=$($NUSPECNAME.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Add nuget.exe uses: nuget/setup-nuget@v1 - name: Add Github Packages source + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} - # Pushes to nuget, not needed unless publishing publicly + # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget push **/*.nupkg -source github - # Pushes to nuget, not needed unless publishing publicly >> this pushes package to nuget.org - name: Publish nuget package to nuget.org + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json + \ No newline at end of file diff --git a/GetPackages.BAT b/GetPackages.BAT new file mode 100644 index 0000000..9b6def3 --- /dev/null +++ b/GetPackages.BAT @@ -0,0 +1,2 @@ +@Echo ON +nuget install .\packages.config -OutputDirectory .\packages -excludeVersion diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user b/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user deleted file mode 100644 index 9c6c209..0000000 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj.user +++ /dev/null @@ -1,5 +0,0 @@ - - - E282E6BE-C7C3-4ece-916A-88FB1CF8AF3C - - \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log b/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log deleted file mode 100644 index b86200d..0000000 --- a/PDT.EssentialsPluginTemplate.EPI/SIMPLSharpLogs/(2019-08-30 15-01-01).log +++ /dev/null @@ -1,63 +0,0 @@ -8/30/2019 3:01:01 PM, Info: Initializing SIMPLSharp Services... -8/30/2019 3:01:01 PM, Info: ProjectInfo successfully initialized. -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:01:02 PM, Info: Saving project information... -8/30/2019 3:04:48 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDashEssentials.dll... -8/30/2019 3:05:10 PM, Info: Saving project information... -8/30/2019 3:05:10 PM, Info: Saving project information... -8/30/2019 3:05:10 PM, Info: Saving project information... -8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Core.dll... -8/30/2019 3:05:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll... -8/30/2019 3:05:40 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_DM.dll... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:24 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:06:36 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:08:54 PM, Info: Saving project information... -8/30/2019 3:09:39 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\essentials-builds\PepperDash_Essentials_Core.dll... -8/30/2019 3:10:10 PM, Info: Saving project information... -8/30/2019 3:10:10 PM, Info: Saving project information... -8/30/2019 3:10:10 PM, Info: Saving project information... -8/30/2019 3:15:10 PM, Info: Saving project information... -8/30/2019 3:15:10 PM, Info: Saving project information... -8/30/2019 3:15:10 PM, Info: Saving project information... -8/30/2019 3:20:10 PM, Info: Saving project information... -8/30/2019 3:20:10 PM, Info: Saving project information... -8/30/2019 3:20:10 PM, Info: Saving project information... -8/30/2019 3:25:10 PM, Info: Saving project information... -8/30/2019 3:25:10 PM, Info: Saving project information... -8/30/2019 3:25:10 PM, Info: Saving project information... -8/30/2019 3:30:10 PM, Info: Saving project information... -8/30/2019 3:30:10 PM, Info: Saving project information... -8/30/2019 3:30:10 PM, Info: Saving project information... -8/30/2019 3:35:10 PM, Info: Saving project information... -8/30/2019 3:35:10 PM, Info: Saving project information... -8/30/2019 3:35:10 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:35:38 PM, Info: Saving project information... -8/30/2019 3:36:52 PM, Info: Validating assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll... -8/30/2019 3:36:52 PM, Info: Verifying assembly C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.dll -8/30/2019 3:36:52 PM, Info: Creating Archive C:\Users\JTA\Documents\Stash Folder\KPMG\SLN103-AVNoc\SLN103-AVNoc.Plugins\NvxUrlRoutingClient.Epi\NvxUrlRoutingClientEpi\bin\Debug\NvxUrlRoutingClientEpi.cplz... -8/30/2019 3:36:53 PM, Info: Saving project information... -9/2/2019 8:34:46 AM, Info: Terminating SIMPLSharp Services diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs b/src/EssentialsPluginTemplateBridgeJoinMap.cs similarity index 91% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs rename to src/EssentialsPluginTemplateBridgeJoinMap.cs index 1f1f9d0..140d021 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateBridgeJoinMap.cs +++ b/src/EssentialsPluginTemplateBridgeJoinMap.cs @@ -12,7 +12,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginBridgeJoinMapTemplate" renamed to "SamsungMdcBridgeJoinMap" /// - public class EssentialsPluginBridgeJoinMapTemplate : JoinMapBaseAdvanced + public class EssentialsPluginTemplateBridgeJoinMap : JoinMapBaseAdvanced { #region Digital @@ -93,8 +93,8 @@ namespace EssentialsPluginTemplate /// Plugin device BridgeJoinMap constructor /// /// This will be the join it starts on the EISC bridge - public EssentialsPluginBridgeJoinMapTemplate(uint joinStart) - : base(joinStart, typeof(EssentialsPluginBridgeJoinMapTemplate)) + public EssentialsPluginTemplateBridgeJoinMap(uint joinStart) + : base(joinStart, typeof(EssentialsPluginTemplateBridgeJoinMap)) { } } diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs b/src/EssentialsPluginTemplateConfigObject.cs similarity index 94% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs rename to src/EssentialsPluginTemplateConfigObject.cs index 027cefe..5894d67 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateConfigObject.cs +++ b/src/EssentialsPluginTemplateConfigObject.cs @@ -1,195 +1,195 @@ -using System.Collections.Generic; -using Newtonsoft.Json; -using PepperDash.Essentials.Core; - -namespace EssentialsPluginTemplate -{ - /// - /// Plugin device configuration object - /// - /// - /// Rename the class to match the device plugin being created - /// - /// - /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" - /// - [ConfigSnippet("\"properties\":{\"control\":{}")] - public class EssentialsPluginConfigObjectTemplate - { - /// - /// JSON control object - /// - /// - /// Typically this object is not required, but in some instances it may be needed. For example, when building a - /// plugin that is using Telnet (TCP/IP) communications and requires login, the device will need to handle the login. - /// In order to do so, you will need the username and password in the "tcpSshProperties" object. - /// - /// - /// - /// "control": { - /// "method": "tcpIp", - /// "controlPortDevKey": "processor", - /// "controlPortNumber": 1, - /// "comParams": { - /// "baudRate": 9600, - /// "dataBits": 8, - /// "stopBits": 1, - /// "parity": "None", - /// "protocol": "RS232", - /// "hardwareHandshake": "None", - /// "softwareHandshake": "None" - /// }, - /// "tcpSshProperties": { - /// "address": "172.22.0.101", - /// "port": 23, - /// "username": "admin", - /// "password": "password", - /// "autoReconnect": true, - /// "autoReconnectIntervalMs": 10000 - /// } - /// } - /// - /// - [JsonProperty("control")] - public EssentialsControlPropertiesConfig Control { get; set; } - - /// - /// Serializes the poll time value - /// - /// - /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. - /// - /// - /// PollTimeMs property gets/sets the value as a long - /// - /// - /// - /// "properties": { - /// "polltimeMs": 30000 - /// } - /// - /// - [JsonProperty("pollTimeMs")] - public long PollTimeMs { get; set; } - - /// - /// Serializes the warning timeout value - /// - /// - /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. - /// - /// - /// WarningTimeoutMs property gets/sets the value as a long - /// - /// - /// - /// "properties": { - /// "warningTimeoutMs": 180000 - /// } - /// - /// - [JsonProperty("warningTimeoutMs")] - public long WarningTimeoutMs { get; set; } - - /// - /// Serializes the error timeout value - /// - /// /// - /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. - /// - /// - /// ErrorTimeoutMs property gets/sets the value as a long - /// - /// - /// - /// "properties": { - /// "errorTimeoutMs": 300000 - /// } - /// - /// - [JsonProperty("errorTimeoutMs")] - public long ErrorTimeoutMs { get; set; } - - /// - /// Example dictionary of objects - /// - /// - /// This is an example collection configuration object. This should be modified or deleted as needed for the plugin being built. - /// - /// - /// - /// "properties": { - /// "presets": { - /// "preset1": { - /// "enabled": true, - /// "name": "Preset 1" - /// } - /// } - /// } - /// - /// - /// - /// - /// "properties": { - /// "inputNames": { - /// "input1": "Input 1", - /// "input2": "Input 2" - /// } - /// } - /// - /// - [JsonProperty("DeviceDictionary")] - public Dictionary DeviceDictionary { get; set; } - - /// - /// Constuctor - /// - /// - /// If using a collection you must instantiate the collection in the constructor - /// to avoid exceptions when reading the configuration file - /// - public EssentialsPluginConfigObjectTemplate() - { - DeviceDictionary = new Dictionary(); - } - } - - /// - /// Example plugin configuration dictionary object - /// - /// - /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. - /// - /// - /// - /// "properties": { - /// "dictionary": { - /// "item1": { - /// "name": "Item 1 Name", - /// "value": "Item 1 Value" - /// } - /// } - /// } - /// - /// - public class EssentialsPluginConfigObjectDictionaryTemplate - { - /// - /// Serializes collection name property - /// - /// - /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. - /// - [JsonProperty("name")] - public string Name { get; set; } - - /// - /// Serializes collection value property - /// - /// - /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. - /// - [JsonProperty("value")] - public uint Value { get; set; } - } +using System.Collections.Generic; +using Newtonsoft.Json; +using PepperDash.Essentials.Core; + +namespace EssentialsPluginTemplate +{ + /// + /// Plugin device configuration object + /// + /// + /// Rename the class to match the device plugin being created + /// + /// + /// "EssentialsPluginConfigObjectTemplate" renamed to "SamsungMdcConfig" + /// + [ConfigSnippet("\"properties\":{\"control\":{}")] + public class EssentialsPluginTemplateConfigObject + { + /// + /// JSON control object + /// + /// + /// Typically this object is not required, but in some instances it may be needed. For example, when building a + /// plugin that is using Telnet (TCP/IP) communications and requires login, the device will need to handle the login. + /// In order to do so, you will need the username and password in the "tcpSshProperties" object. + /// + /// + /// + /// "control": { + /// "method": "tcpIp", + /// "controlPortDevKey": "processor", + /// "controlPortNumber": 1, + /// "comParams": { + /// "baudRate": 9600, + /// "dataBits": 8, + /// "stopBits": 1, + /// "parity": "None", + /// "protocol": "RS232", + /// "hardwareHandshake": "None", + /// "softwareHandshake": "None" + /// }, + /// "tcpSshProperties": { + /// "address": "172.22.0.101", + /// "port": 23, + /// "username": "admin", + /// "password": "password", + /// "autoReconnect": true, + /// "autoReconnectIntervalMs": 10000 + /// } + /// } + /// + /// + [JsonProperty("control")] + public EssentialsControlPropertiesConfig Control { get; set; } + + /// + /// Serializes the poll time value + /// + /// + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// + /// + /// PollTimeMs property gets/sets the value as a long + /// + /// + /// + /// "properties": { + /// "polltimeMs": 30000 + /// } + /// + /// + [JsonProperty("pollTimeMs")] + public long PollTimeMs { get; set; } + + /// + /// Serializes the warning timeout value + /// + /// + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// + /// + /// WarningTimeoutMs property gets/sets the value as a long + /// + /// + /// + /// "properties": { + /// "warningTimeoutMs": 180000 + /// } + /// + /// + [JsonProperty("warningTimeoutMs")] + public long WarningTimeoutMs { get; set; } + + /// + /// Serializes the error timeout value + /// + /// /// + /// This is an exmaple device plugin property. This should be modified or deleted as needed for the plugin being built. + /// + /// + /// ErrorTimeoutMs property gets/sets the value as a long + /// + /// + /// + /// "properties": { + /// "errorTimeoutMs": 300000 + /// } + /// + /// + [JsonProperty("errorTimeoutMs")] + public long ErrorTimeoutMs { get; set; } + + /// + /// Example dictionary of objects + /// + /// + /// This is an example collection configuration object. This should be modified or deleted as needed for the plugin being built. + /// + /// + /// + /// "properties": { + /// "presets": { + /// "preset1": { + /// "enabled": true, + /// "name": "Preset 1" + /// } + /// } + /// } + /// + /// + /// + /// + /// "properties": { + /// "inputNames": { + /// "input1": "Input 1", + /// "input2": "Input 2" + /// } + /// } + /// + /// + [JsonProperty("DeviceDictionary")] + public Dictionary DeviceDictionary { get; set; } + + /// + /// Constuctor + /// + /// + /// If using a collection you must instantiate the collection in the constructor + /// to avoid exceptions when reading the configuration file + /// + public EssentialsPluginConfigObjectTemplate() + { + DeviceDictionary = new Dictionary(); + } + } + + /// + /// Example plugin configuration dictionary object + /// + /// + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// + /// + /// + /// "properties": { + /// "dictionary": { + /// "item1": { + /// "name": "Item 1 Name", + /// "value": "Item 1 Value" + /// } + /// } + /// } + /// + /// + public class EssentialsPluginTemplateConfigObjectDictionary + { + /// + /// Serializes collection name property + /// + /// + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// + [JsonProperty("name")] + public string Name { get; set; } + + /// + /// Serializes collection value property + /// + /// + /// This is an example collection of configuration objects. This can be modified or deleted as needed for the plugin being built. + /// + [JsonProperty("value")] + public uint Value { get; set; } + } } \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs b/src/EssentialsPluginTemplateCrestronDevice.cs similarity index 98% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs rename to src/EssentialsPluginTemplateCrestronDevice.cs index 2377387..7da4ddf 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateCrestronDevice.cs +++ b/src/EssentialsPluginTemplateCrestronDevice.cs @@ -23,7 +23,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginConfigObjectTemplate _config; + private EssentialsPluginTemplateConfigObject _config; #region Constructor for Devices without IBasicCommunication. Remove if not needed diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs b/src/EssentialsPluginTemplateDevice.cs similarity index 97% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs rename to src/EssentialsPluginTemplateDevice.cs index 20c99da..d08418c 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateDevice.cs +++ b/src/EssentialsPluginTemplateDevice.cs @@ -24,7 +24,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginConfigObjectTemplate _config; + private EssentialsPluginTemplateConfigObject _config; /// /// Provides a queue and dedicated worker thread for processing feedback messages from a device. @@ -98,7 +98,7 @@ namespace EssentialsPluginTemplate /// /// /// - public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, IBasicCommunication comms) + public EssentialsPluginTemplateDevice(string key, string name, EssentialsPluginTemplateConfigObject config, IBasicCommunication comms) : base(key, name) { Debug.Console(0, this, "Constructing new {0} instance", name); @@ -244,7 +244,7 @@ namespace EssentialsPluginTemplate /// public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) { - var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); + var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); // This adds the join map to the collection on the bridge if (bridge != null) diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs b/src/EssentialsPluginTemplateFactory.cs similarity index 95% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs rename to src/EssentialsPluginTemplateFactory.cs index 1798d19..d2eddce 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateFactory.cs +++ b/src/EssentialsPluginTemplateFactory.cs @@ -14,7 +14,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginFactoryTemplate" renamed to "MyDeviceFactory" /// - public class EssentialsPluginFactoryTemplate : EssentialsPluginDeviceFactory + public class EssentialsPluginTemplateFactory : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -32,7 +32,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginFactoryTemplate() + public EssentialsPluginTemplateFactory() { // Set the minimum Essentials Framework Version // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against @@ -58,7 +58,7 @@ namespace EssentialsPluginTemplate Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); // get the plugin device properties configuration object & check for null - var propertiesConfig = dc.Properties.ToObject(); + var propertiesConfig = dc.Properties.ToObject(); if (propertiesConfig == null) { Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); @@ -91,7 +91,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginFactoryTemplate" renamed to "MyLogicDeviceFactory" /// - public class EssentialsPluginFactoryLogicDeviceTemplate : EssentialsPluginDeviceFactory + public class EssentialsPluginTemplateFactoryLogicDevice : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -109,7 +109,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginFactoryLogicDeviceTemplate() + public EssentialsPluginTemplateFactoryLogicDevice() { // Set the minimum Essentials Framework Version // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against @@ -136,7 +136,7 @@ namespace EssentialsPluginTemplate Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); // get the plugin device properties configuration object & check for null - var propertiesConfig = dc.Properties.ToObject(); + var propertiesConfig = dc.Properties.ToObject(); if (propertiesConfig == null) { Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); @@ -166,7 +166,7 @@ namespace EssentialsPluginTemplate /// /// "EssentialsPluginFactoryTemplate" renamed to "MyCrestronDeviceFactory" /// - public class EssentialsPluginFactoryCrestronDeviceTemplate : EssentialsPluginDeviceFactory + public class EssentialsPluginTemplateFactoryCrestronDevice : EssentialsPluginDeviceFactory { /// /// Plugin device factory constructor @@ -184,7 +184,7 @@ namespace EssentialsPluginTemplate /// TypeNames = new List() { "SamsungMdc", "SamsungMdcDisplay" }; /// /// - public EssentialsPluginFactoryCrestronDeviceTemplate() + public EssentialsPluginTemplateFactoryCrestronDevice() { // Set the minimum Essentials Framework Version // TODO [ ] Update the Essentials minimum framework version which this plugin has been tested against diff --git a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs b/src/EssentialsPluginTemplateLogicDevice.cs similarity index 92% rename from PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs rename to src/EssentialsPluginTemplateLogicDevice.cs index eda5ad0..0685a43 100644 --- a/PDT.EssentialsPluginTemplate.EPI/EssentialsPluginTemplateLogicDevice.cs +++ b/src/EssentialsPluginTemplateLogicDevice.cs @@ -19,7 +19,7 @@ namespace EssentialsPluginTemplate /// /// It is often desirable to store the config /// - private EssentialsPluginConfigObjectTemplate _config; + private EssentialsPluginTemplateConfigObject _config; /// /// Plugin device constructor @@ -27,7 +27,7 @@ namespace EssentialsPluginTemplate /// /// /// - public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginConfigObjectTemplate config) + public EssentialsPluginTemplateLogicDevice(string key, string name, EssentialsPluginTemplateConfigObject config) : base(key, name) { Debug.Console(0, this, "Constructing new {0} instance", name); @@ -48,7 +48,7 @@ namespace EssentialsPluginTemplate /// public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) { - var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); + var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); // This adds the join map to the collection on the bridge if (bridge != null) diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj b/src/PDT.EssentialsPluginTemplate.EPI.csproj similarity index 98% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj rename to src/PDT.EssentialsPluginTemplate.EPI.csproj index 6dd00f2..edda00c 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.csproj +++ b/src/PDT.EssentialsPluginTemplate.EPI.csproj @@ -1,115 +1,115 @@ - - - Release - AnyCPU - 9.0.30729 - 2.0 - {9D249E47-8F95-4437-A6BB-563510287AD1} - Library - Properties - PDT.EssentialsPluginTemplate.EPI - PDT.EssentialsPluginTemplate.EPI - {0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} - WindowsCE - E2BECB1F-8C8C-41ba-B736-9BE7D946A398 - 5.0 - SmartDeviceProject1 - v3.5 - Windows CE - - - - - .allowedReferenceRelatedFileExtensions - true - full - false - bin\Debug\ - DEBUG;TRACE; - prompt - 4 - 512 - true - true - off - - - .allowedReferenceRelatedFileExtensions - none - true - bin\Release\ - prompt - 4 - 512 - true - true - off - - - - False - ..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll - - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll - - - False - ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe - False - - - False - ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll - - - - - - - - - - - - - - - - - - rem S# Pro preparation will execute after these operations - + + + Release + AnyCPU + 9.0.30729 + 2.0 + {9D249E47-8F95-4437-A6BB-563510287AD1} + Library + Properties + PDT.EssentialsPluginTemplate.EPI + PDT.EssentialsPluginTemplate.EPI + {0B4745B0-194B-4BB6-8E21-E9057CA92300};{4D628B5B-2FBC-4AA6-8C16-197242AEB884};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} + WindowsCE + E2BECB1F-8C8C-41ba-B736-9BE7D946A398 + 5.0 + SmartDeviceProject1 + v3.5 + Windows CE + + + + + .allowedReferenceRelatedFileExtensions + true + full + false + bin\Debug\ + DEBUG;TRACE; + prompt + 4 + 512 + true + true + off + + + .allowedReferenceRelatedFileExtensions + none + true + bin\Release\ + prompt + 4 + 512 + true + true + off + + + + False + ..\..\..\..\ProgramData\Crestron\SDK\SSPDevices\Crestron.SimplSharpPro.UI.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\Essentials Devices Common.dll + + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDashEssentials.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Core.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_Core.dll + + + False + ..\packages\PepperDashEssentials\lib\net35\PepperDash_Essentials_DM.dll + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpCustomAttributesInterface.dll + False + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpHelperInterface.dll + False + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpNewtonsoft.dll + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpPro.exe + False + + + False + ..\..\..\..\..\..\..\..\..\ProgramData\Crestron\SDK\SimplSharpReflectionInterface.dll + + + + + + + + + + + + + + + + + + rem S# Pro preparation will execute after these operations + \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln b/src/PDT.EssentialsPluginTemplate.EPI.sln similarity index 97% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln rename to src/PDT.EssentialsPluginTemplate.EPI.sln index 08ca093..f453fd6 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.EPI.sln +++ b/src/PDT.EssentialsPluginTemplate.EPI.sln @@ -1,20 +1,20 @@ - -Microsoft Visual Studio Solution File, Format Version 10.00 -# Visual Studio 2008 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PDT.EssentialsPluginTemplate.EPI", "PDT.EssentialsPluginTemplate.EPI.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU - {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal + +Microsoft Visual Studio Solution File, Format Version 10.00 +# Visual Studio 2008 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PDT.EssentialsPluginTemplate.EPI", "PDT.EssentialsPluginTemplate.EPI.csproj", "{9D249E47-8F95-4437-A6BB-563510287AD1}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9D249E47-8F95-4437-A6BB-563510287AD1}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE b/src/PDT.EssentialsPluginTemplate.nuspec similarity index 81% rename from PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE rename to src/PDT.EssentialsPluginTemplate.nuspec index 7b99bed..e72f807 100644 --- a/PDT.EssentialsPluginTemplate.EPI/PDT.EssentialsPluginTemplate.nuspec-TEMPLATE +++ b/src/PDT.EssentialsPluginTemplate.nuspec @@ -2,6 +2,7 @@ PDT.EssentialsPluginTemplate + docs\README.md 2.0.2 Essentials Plugin Template PepperDash Technologies @@ -11,11 +12,12 @@ https://github.com/PepperDash/EssentialsPluginTemplate Copyright 2022 This software iserves as a template for generating new Essentials-Compliant plugins - crestron 3series 4series samsung + crestron 3series 4series essentials pepperdash pepperdashessentials epi essentials plugin + \ No newline at end of file diff --git a/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs b/src/Properties/AssemblyInfo.cs similarity index 97% rename from PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs rename to src/Properties/AssemblyInfo.cs index e8f1480..275e917 100644 --- a/PDT.EssentialsPluginTemplate.EPI/Properties/AssemblyInfo.cs +++ b/src/Properties/AssemblyInfo.cs @@ -1,8 +1,8 @@ -using System.Reflection; - -[assembly: AssemblyTitle("EssentialsPluginTemplateEpi")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("EssentialsPluginTemplateEpi")] -[assembly: AssemblyCopyright("Copyright © 2022")] -[assembly: AssemblyVersion("1.0.0.*")] - +using System.Reflection; + +[assembly: AssemblyTitle("EssentialsPluginTemplateEpi")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("EssentialsPluginTemplateEpi")] +[assembly: AssemblyCopyright("Copyright © 2022")] +[assembly: AssemblyVersion("1.0.0.*")] + diff --git a/PDT.EssentialsPluginTemplate.EPI/Properties/ControlSystem.cfg b/src/Properties/ControlSystem.cfg similarity index 100% rename from PDT.EssentialsPluginTemplate.EPI/Properties/ControlSystem.cfg rename to src/Properties/ControlSystem.cfg From 57a265d27f27018d988863ba529bf58dd060da49 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 16:48:50 -0500 Subject: [PATCH 03/16] Made names of classes more consistent internally Removed obsolete references --- src/EssentialsPluginTemplateConfigObject.cs | 6 +++--- src/EssentialsPluginTemplateCrestronDevice.cs | 4 ++-- src/EssentialsPluginTemplateDevice.cs | 2 +- src/EssentialsPluginTemplateFactory.cs | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/EssentialsPluginTemplateConfigObject.cs b/src/EssentialsPluginTemplateConfigObject.cs index 5894d67..e216796 100644 --- a/src/EssentialsPluginTemplateConfigObject.cs +++ b/src/EssentialsPluginTemplateConfigObject.cs @@ -139,7 +139,7 @@ namespace EssentialsPluginTemplate /// /// [JsonProperty("DeviceDictionary")] - public Dictionary DeviceDictionary { get; set; } + public Dictionary DeviceDictionary { get; set; } /// /// Constuctor @@ -148,9 +148,9 @@ namespace EssentialsPluginTemplate /// If using a collection you must instantiate the collection in the constructor /// to avoid exceptions when reading the configuration file /// - public EssentialsPluginConfigObjectTemplate() + public EssentialsPluginTemplateConfigObject() { - DeviceDictionary = new Dictionary(); + DeviceDictionary = new Dictionary(); } } diff --git a/src/EssentialsPluginTemplateCrestronDevice.cs b/src/EssentialsPluginTemplateCrestronDevice.cs index 7da4ddf..8836cc5 100644 --- a/src/EssentialsPluginTemplateCrestronDevice.cs +++ b/src/EssentialsPluginTemplateCrestronDevice.cs @@ -34,7 +34,7 @@ namespace EssentialsPluginTemplate /// /// /// - public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginConfigObjectTemplate config, GenericBase hardware) + public EssentialsPluginTemplateCrestronDevice(string key, string name, EssentialsPluginTemplateConfigObject config, GenericBase hardware) : base(key, name, hardware) { Debug.Console(0, this, "Constructing new {0} instance", name); @@ -60,7 +60,7 @@ namespace EssentialsPluginTemplate /// public override void LinkToApi(BasicTriList trilist, uint joinStart, string joinMapKey, EiscApiAdvanced bridge) { - var joinMap = new EssentialsPluginBridgeJoinMapTemplate(joinStart); + var joinMap = new EssentialsPluginTemplateBridgeJoinMap(joinStart); // This adds the join map to the collection on the bridge if (bridge != null) diff --git a/src/EssentialsPluginTemplateDevice.cs b/src/EssentialsPluginTemplateDevice.cs index d08418c..b6d2031 100644 --- a/src/EssentialsPluginTemplateDevice.cs +++ b/src/EssentialsPluginTemplateDevice.cs @@ -5,7 +5,7 @@ using Crestron.SimplSharpPro.DeviceSupport; using PepperDash.Core; using PepperDash.Essentials.Core; using PepperDash.Essentials.Core.Bridges; -using PepperDash_Essentials_Core.Queues; +using PepperDash.Essentials.Core.Queues; namespace EssentialsPluginTemplate diff --git a/src/EssentialsPluginTemplateFactory.cs b/src/EssentialsPluginTemplateFactory.cs index d2eddce..0b58f52 100644 --- a/src/EssentialsPluginTemplateFactory.cs +++ b/src/EssentialsPluginTemplateFactory.cs @@ -211,7 +211,7 @@ namespace EssentialsPluginTemplate Debug.Console(1, "[{0}] Factory Attempting to create new device from type: {1}", dc.Key, dc.Type); // get the plugin device properties configuration object & check for null - var propertiesConfig = dc.Properties.ToObject(); + var propertiesConfig = dc.Properties.ToObject(); if (propertiesConfig == null) { Debug.Console(0, "[{0}] Factory: failed to read properties config for {1}", dc.Key, dc.Name); From baaf7c4a28bb4d43dc0db1592b0119c52746d008 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 17:11:15 -0500 Subject: [PATCH 04/16] fix: Workflow Syntax --- .../essentialsplugins-betabuilds.yml | 21 ++++++++++----- .../essentialsplugins-releasebuilds.yml | 26 ++++++++++++------- 2 files changed, 32 insertions(+), 15 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 8fcbbf8..5219292 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -222,13 +222,23 @@ jobs: Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 - env: NUSPECNAME + env: + NUSPECNAME: default steps: + - name: Get nuget File + shell: powershell + run: | + $nuspec = Get-ChildItem *.nuspec -recurse + $NUSPECNAME = nuspec.BaseName + echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + - name: Download Build Version Info + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' shell: powershell run: | Get-ChildItem "./Version" @@ -238,26 +248,25 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output + :if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: | Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse #Pushes to github nuget store - - name: Get nuget File - shell: powershell - run: | - $NUSPECNAME = Get-ChildItem *.nuspec -recurse - echo "NUSPEC_FILE=$($NUSPECNAME.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Add nuget.exe + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' uses: nuget/setup-nuget@v1 - name: Add Github Packages source if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index ff951dd..7537af9 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -170,13 +170,23 @@ jobs: Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 - env: NUSPECNAME + env: + NUSPECNAME: default steps: + - name: Get nuget File + shell: powershell + run: | + $nuspec = Get-ChildItem *.nuspec -recurse + $NUSPECNAME = nuspec.BaseName + echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + - name: Download Build Version Info + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' shell: powershell run: | Get-ChildItem "./Version" @@ -186,26 +196,25 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output + :if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: | - Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz","*.md") + Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse - # Pushes to github nuget store - - name: Get nuget File - shell: powershell - run: | - $NUSPECNAME = Get-ChildItem *.nuspec -recurse - echo "NUSPEC_FILE=$($NUSPECNAME.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + #Pushes to github nuget store - name: Add nuget.exe + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' uses: nuget/setup-nuget@v1 - name: Add Github Packages source if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' @@ -223,4 +232,3 @@ jobs: - name: Publish nuget package to nuget.org if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json - \ No newline at end of file From 592400cc90033735029e271801fbc53d2b4e6535 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 17:12:21 -0500 Subject: [PATCH 05/16] fix: Workflow Syntax --- .github/workflows/essentialsplugins-betabuilds.yml | 2 +- .github/workflows/essentialsplugins-releasebuilds.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 5219292..94c9423 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -248,7 +248,7 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - :if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' uses: actions/download-artifact@v1 with: name: Build diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index 7537af9..9d656db 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -196,7 +196,7 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - :if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' uses: actions/download-artifact@v1 with: name: Build From 266bf187d955d6c6148df68c721ac11bd628db91 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 17:15:39 -0500 Subject: [PATCH 06/16] fix: Workflow Syntax --- .../essentialsplugins-betabuilds.yml | 22 +++++++++---------- .../essentialsplugins-releasebuilds.yml | 22 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 94c9423..4dcf064 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -233,12 +233,12 @@ jobs: echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} shell: powershell run: | Get-ChildItem "./Version" @@ -248,39 +248,39 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: | Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse #Pushes to github nuget store - name: Add nuget.exe - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} uses: nuget/setup-nuget@v1 - name: Add Github Packages source - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index 9d656db..c5bd360 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -181,12 +181,12 @@ jobs: echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} shell: powershell run: | Get-ChildItem "./Version" @@ -196,39 +196,39 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: | Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse #Pushes to github nuget store - name: Add nuget.exe - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} uses: nuget/setup-nuget@v1 - name: Add Github Packages source - if: $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && $NUSPECNAME != 'PDT.EssentialsPluginTemplate' + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json From 87872b78e28ac5a037a6e195fff618e4a420401e Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 17:29:57 -0500 Subject: [PATCH 07/16] fix: Workflow Syntax --- .github/workflows/essentialsplugins-betabuilds.yml | 2 +- .github/workflows/essentialsplugins-releasebuilds.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 4dcf064..4a52ae5 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -229,7 +229,7 @@ jobs: shell: powershell run: | $nuspec = Get-ChildItem *.nuspec -recurse - $NUSPECNAME = nuspec.BaseName + $NUSPECNAME = $nuspec.BaseName echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index c5bd360..45ee9db 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -177,7 +177,7 @@ jobs: shell: powershell run: | $nuspec = Get-ChildItem *.nuspec -recurse - $NUSPECNAME = nuspec.BaseName + $NUSPECNAME = $nuspec.BaseName echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info From 856178d920e5dff018ed6c484214aa78bece3a3d Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 17:53:48 -0500 Subject: [PATCH 08/16] fix: Workflow Syntax --- .github/workflows/essentialsplugins-betabuilds.yml | 6 +++--- .github/workflows/essentialsplugins-releasebuilds.yml | 7 +++---- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 4a52ae5..3dd9b81 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -228,9 +228,9 @@ jobs: - name: Get nuget File shell: powershell run: | - $nuspec = Get-ChildItem *.nuspec -recurse - $NUSPECNAME = $nuspec.BaseName - echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + $nuspec_file = Get-ChildItem *.nuspec -recurse + env.NUSPECNAME = $($nuspec_file.BaseName) + echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index 45ee9db..3cf0c26 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -176,10 +176,9 @@ jobs: - name: Get nuget File shell: powershell run: | - $nuspec = Get-ChildItem *.nuspec -recurse - $NUSPECNAME = $nuspec.BaseName - echo "NUSPEC_FILE=$($NUSPECNAME)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - + $nuspec_file = Get-ChildItem *.nuspec -recurse + env.NUSPECNAME = $($nuspec_file.BaseName) + echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} uses: actions/download-artifact@v1 From 3d57ac3560ffa242c097ba194df73be96e0d78b3 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 18:18:07 -0500 Subject: [PATCH 09/16] fix: Workflow Syntax --- .../essentialsplugins-betabuilds.yml | 25 +++++++++---------- .../essentialsplugins-releasebuilds.yml | 24 +++++++++--------- 2 files changed, 24 insertions(+), 25 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 3dd9b81..cfcea42 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -229,16 +229,15 @@ jobs: shell: powershell run: | $nuspec_file = Get-ChildItem *.nuspec -recurse - env.NUSPECNAME = $($nuspec_file.BaseName) + ${{ env.NUSPECNAME }} = $($nuspec_file.BaseName) echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Download Build Version Info - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate '}} uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} shell: powershell run: | Get-ChildItem "./Version" @@ -248,39 +247,39 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: | Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse #Pushes to github nuget store - name: Add nuget.exe - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} uses: nuget/setup-nuget@v1 - name: Add Github Packages source - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index 3cf0c26..c6837a4 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -177,15 +177,15 @@ jobs: shell: powershell run: | $nuspec_file = Get-ChildItem *.nuspec -recurse - env.NUSPECNAME = $($nuspec_file.BaseName) + ${{ env.NUSPECNAME }} = $($nuspec_file.BaseName) echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate '}} uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} shell: powershell run: | Get-ChildItem "./Version" @@ -195,39 +195,39 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: | Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse #Pushes to github nuget store - name: Add nuget.exe - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} uses: nuget/setup-nuget@v1 - name: Add Github Packages source - if: ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{env.NUSPECNAME != 'PDT.EssentialsPluginTemplate'}} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json From 1add0c193ce57acb9e147534398b5fad75c8d765 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 18:34:20 -0500 Subject: [PATCH 10/16] fix: Workflow Syntax --- .github/workflows/essentialsplugins-betabuilds.yml | 2 +- .github/workflows/essentialsplugins-releasebuilds.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index cfcea42..56515c2 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -229,7 +229,7 @@ jobs: shell: powershell run: | $nuspec_file = Get-ChildItem *.nuspec -recurse - ${{ env.NUSPECNAME }} = $($nuspec_file.BaseName) + echo "NUSPECNAME=$($nuspec_file.BaseName)" >> $GITHUB_ENV echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate '}} diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index c6837a4..eab1043 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -177,7 +177,7 @@ jobs: shell: powershell run: | $nuspec_file = Get-ChildItem *.nuspec -recurse - ${{ env.NUSPECNAME }} = $($nuspec_file.BaseName) + echo "NUSPECNAME=$($nuspec_file.BaseName)" >> $GITHUB_ENV echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate '}} From f08741efd6ae61486bfd16419c9fc92d15c3382f Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 20:32:42 -0500 Subject: [PATCH 11/16] fix: Workflow Syntax --- .../essentialsplugins-releasebuilds.yml | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index eab1043..4be26b4 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -180,12 +180,12 @@ jobs: echo "NUSPECNAME=$($nuspec_file.BaseName)" >> $GITHUB_ENV echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate '}} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" shell: powershell run: | Get-ChildItem "./Version" @@ -195,39 +195,39 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: | Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse #Pushes to github nuget store - name: Add nuget.exe - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: nuget/setup-nuget@v1 - name: Add Github Packages source - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json From af7e9ae659a367e05498a4f265dc7c94194a03aa Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 21:03:26 -0500 Subject: [PATCH 12/16] fix: Workflow Syntax --- .../essentialsplugins-betabuilds.yml | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 56515c2..90374b7 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -232,12 +232,12 @@ jobs: echo "NUSPECNAME=$($nuspec_file.BaseName)" >> $GITHUB_ENV echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate '}} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" shell: powershell run: | Get-ChildItem "./Version" @@ -247,39 +247,39 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: | Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse #Pushes to github nuget store - name: Add nuget.exe - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: nuget/setup-nuget@v1 - name: Add Github Packages source - if: ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && ${{ env.NUSPECNAME != 'PDT.EssentialsPluginTemplate' }} + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json From ee057ad3618faf378e6db98fdb24fc14b6fdebd1 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 21:47:09 -0500 Subject: [PATCH 13/16] fix: Workflow Syntax --- .github/workflows/essentialsplugins-betabuilds.yml | 8 ++++---- .github/workflows/essentialsplugins-releasebuilds.yml | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index 90374b7..f3f4657 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -272,14 +272,14 @@ jobs: run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index 4be26b4..869ddf9 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -220,14 +220,14 @@ jobs: run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} # Pushes to nuget gallery, not needed unless publishing publicly - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json From 62912451e8757568180f937c4c67c5979fa0ceb3 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Wed, 20 Jul 2022 22:15:48 -0500 Subject: [PATCH 14/16] fix: Workflow Syntax --- .github/workflows/essentialsplugins-betabuilds.yml | 4 ++-- .github/workflows/essentialsplugins-releasebuilds.yml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index f3f4657..c2df4dc 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -229,8 +229,8 @@ jobs: shell: powershell run: | $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPECNAME=$($nuspec_file.BaseName)" >> $GITHUB_ENV - echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + echo "NUSPECNAME=$($nuspec_file.BaseName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + echo "NUSPEC_FILE=$($nuspec_file.BaseName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: actions/download-artifact@v1 diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index 869ddf9..be6aed4 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -177,8 +177,8 @@ jobs: shell: powershell run: | $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPECNAME=$($nuspec_file.BaseName)" >> $GITHUB_ENV - echo "NUSPEC_FILE=$($nuspec_file.BaseName)"| Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + echo "NUSPECNAME=$($nuspec_file.BaseName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + echo "NUSPEC_FILE=$($nuspec_file.BaseName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: actions/download-artifact@v1 From 62f959bb259cd8159d60c4b0bfed97d303ae3bec Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Thu, 21 Jul 2022 10:17:56 -0500 Subject: [PATCH 15/16] test workflow syntax --- .../essentialsplugins-betabuilds.yml | 20 +++--- .../essentialsplugins-releasebuilds.yml | 61 ++++++++++++++++++- 2 files changed, 68 insertions(+), 13 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index c2df4dc..fa3e21c 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -225,19 +225,11 @@ jobs: env: NUSPECNAME: default steps: - - name: Get nuget File - shell: powershell - run: | - $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPECNAME=$($nuspec_file.BaseName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - echo "NUSPEC_FILE=$($nuspec_file.BaseName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - name: Download Build Version Info - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: actions/download-artifact@v1 with: name: Version - name: Set Version Number - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" shell: powershell run: | Get-ChildItem "./Version" @@ -247,22 +239,26 @@ jobs: Remove-Item -Path ./Version/version.txt Remove-Item -Path ./Version - name: Download Build output - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" uses: actions/download-artifact@v1 with: name: Build path: ./ - name: Unzip Build file - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: | Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ Remove-Item -Path .\*.zip - name: Copy Files to root & delete output directory - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: | Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ Remove-Item -Path .\output -Recurse + - name: Get nuget File + shell: powershell + run: | + $nuspec_file = (Get-ChildItem *.nuspec -recurse).BaseName + echo "NUSPECNAME=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + echo "NUSPEC_FILE=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + #Pushes to github nuget store - name: Add nuget.exe if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" @@ -270,7 +266,7 @@ jobs: - name: Add Github Packages source if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} - # Pushes to nuget gallery, not needed unless publishing publicly + # Pushes to nuget gallery - name: Add nuget.org API Key if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index be6aed4..18b3771 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -167,7 +167,6 @@ jobs: asset_content_type: application/zip env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 env: @@ -231,3 +230,63 @@ jobs: - name: Publish nuget package to nuget.org if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json + Push_Nuget_Package: + needs: Build_Project + runs-on: windows-2019 + env: + NUSPECNAME: default + steps: + - name: Download Build Version Info + uses: actions/download-artifact@v1 + with: + name: Version + - name: Set Version Number + shell: powershell + run: | + Get-ChildItem "./Version" + $version = Get-Content -Path ./Version/version.txt + Write-Host "Version: $version" + echo "VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + Remove-Item -Path ./Version/version.txt + Remove-Item -Path ./Version + - name: Download Build output + uses: actions/download-artifact@v1 + with: + name: Build + path: ./ + - name: Unzip Build file + run: | + Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ + Remove-Item -Path .\*.zip + - name: Copy Files to root & delete output directory + run: | + Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") + Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ + Remove-Item -Path .\output -Recurse + - name: Get nuget File + shell: powershell + run: | + $nuspec_file = (Get-ChildItem *.nuspec -recurse).BaseName + echo "NUSPECNAME=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + echo "NUSPEC_FILE=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append + + #Pushes to github nuget store + - name: Add nuget.exe + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + uses: nuget/setup-nuget@v1 + - name: Add Github Packages source + if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} + # Pushes to nuget gallery + - name: Add nuget.org API Key + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') + run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} + - name: Create nuget package + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') + run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} + - name: Publish nuget package to Github registry + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') + run: nuget push **/*.nupkg -source github + - name: Publish nuget package to nuget.org + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') + run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json From 259a71c562f1e0c939548e71ae2313de314985c3 Mon Sep 17 00:00:00 2001 From: Trevor Payne Date: Thu, 21 Jul 2022 12:07:27 -0500 Subject: [PATCH 16/16] style: renamed classes for consistency build: updated essentials version ci: updated workflows docs: documentation updated ci: updated nuspec --- .../essentialsplugins-betabuilds.yml | 30 +++--- .../essentialsplugins-releasebuilds.yml | 91 +++---------------- README.md | 16 ++-- 3 files changed, 37 insertions(+), 100 deletions(-) diff --git a/.github/workflows/essentialsplugins-betabuilds.yml b/.github/workflows/essentialsplugins-betabuilds.yml index fa3e21c..3b42815 100644 --- a/.github/workflows/essentialsplugins-betabuilds.yml +++ b/.github/workflows/essentialsplugins-betabuilds.yml @@ -153,7 +153,7 @@ jobs: $exclusions = "packages" # Trying to get any .json schema files (not currently working) # Gets any files with the listed extensions. - Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz", "*.nuspec" | ForEach-Object { + Get-ChildItem -recurse -Path "$($Env:GITHUB_WORKSPACE)" -include "*.clz", "*.cpz", "*.cplz", "*.nuspec", "*.md" | ForEach-Object { $allowed = $true; # Exclude any files in submodules foreach ($exclude in $exclusions) { @@ -222,8 +222,6 @@ jobs: Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 - env: - NUSPECNAME: default steps: - name: Download Build Version Info uses: actions/download-artifact@v1 @@ -256,26 +254,26 @@ jobs: shell: powershell run: | $nuspec_file = (Get-ChildItem *.nuspec -recurse).BaseName - echo "NUSPECNAME=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append echo "NUSPEC_FILE=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - #Pushes to github nuget store + # Pulls the nuget builder packages - name: Add nuget.exe - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" uses: nuget/setup-nuget@v1 + # Creating nuget Packages - name: Add Github Packages source - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} + - name: Create nuget package + if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" + run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} + # Pushes to internal github registry + - name: Publish nuget package to Github registry + if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" + run: nuget push **/*.nupkg -source github # Pushes to nuget gallery - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate') run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate') run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/.github/workflows/essentialsplugins-releasebuilds.yml b/.github/workflows/essentialsplugins-releasebuilds.yml index 18b3771..2ae1117 100644 --- a/.github/workflows/essentialsplugins-releasebuilds.yml +++ b/.github/workflows/essentialsplugins-releasebuilds.yml @@ -167,74 +167,9 @@ jobs: asset_content_type: application/zip env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - needs: Build_Project - runs-on: windows-2019 - env: - NUSPECNAME: default - steps: - - name: Get nuget File - shell: powershell - run: | - $nuspec_file = Get-ChildItem *.nuspec -recurse - echo "NUSPECNAME=$($nuspec_file.BaseName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - echo "NUSPEC_FILE=$($nuspec_file.BaseName)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Download Build Version Info - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: actions/download-artifact@v1 - with: - name: Version - - name: Set Version Number - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - shell: powershell - run: | - Get-ChildItem "./Version" - $version = Get-Content -Path ./Version/version.txt - Write-Host "Version: $version" - echo "VERSION=$version" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - Remove-Item -Path ./Version/version.txt - Remove-Item -Path ./Version - - name: Download Build output - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: actions/download-artifact@v1 - with: - name: Build - path: ./ - - name: Unzip Build file - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: | - Get-ChildItem .\*.zip | Expand-Archive -DestinationPath .\ - Remove-Item -Path .\*.zip - - name: Copy Files to root & delete output directory - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: | - Remove-Item -Path .\* -Include @("*.cpz","*.md","*.cplz","*.json","*.dll","*.clz") - Get-ChildItem -Path .\output\* | Copy-Item -Destination .\ - Remove-Item -Path .\output -Recurse - #Pushes to github nuget store - - name: Add nuget.exe - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - uses: nuget/setup-nuget@v1 - - name: Add Github Packages source - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" - run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} - # Pushes to nuget gallery, not needed unless publishing publicly - - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget push **/*.nupkg -source github - - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json Push_Nuget_Package: needs: Build_Project runs-on: windows-2019 - env: - NUSPECNAME: default steps: - name: Download Build Version Info uses: actions/download-artifact@v1 @@ -267,26 +202,26 @@ jobs: shell: powershell run: | $nuspec_file = (Get-ChildItem *.nuspec -recurse).BaseName - echo "NUSPECNAME=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append echo "NUSPEC_FILE=$($nuspec_file)" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - #Pushes to github nuget store + # Pulls the nuget builder packages - name: Add nuget.exe - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" uses: nuget/setup-nuget@v1 + # Creating nuget Packages - name: Add Github Packages source - if: "!contains(env.NUSPECNAME, 'EssentialsPluginTemplate')" + if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" run: nuget sources add -name github -source https://nuget.pkg.github.com/pepperdash/index.json -username Pepperdash -password ${{ secrets.GITHUB_TOKEN }} + - name: Create nuget package + if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" + run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} + # Pushes to internal github registry + - name: Publish nuget package to Github registry + if: "!contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate')" + run: nuget push **/*.nupkg -source github # Pushes to nuget gallery - name: Add nuget.org API Key - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate') run: nuget setApiKey ${{ secrets.NUGET_API_KEY }} - - name: Create nuget package - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget pack "./${{ env.NUSPEC_FILE}}.nuspec" -version ${{ env.VERSION }} - - name: Publish nuget package to Github registry - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') - run: nuget push **/*.nupkg -source github - name: Publish nuget package to nuget.org - if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPECNAME, 'EssentialsPluginTemplate') + if: github.repository_owner == 'PepperDash' && github.repository_visibility == 'public' && !contains(env.NUSPEC_FILE, 'EssentialsPluginTemplate') run: nuget push **/*.nupkg -Source https://api.nuget.org/v3/index.json diff --git a/README.md b/README.md index 8dfb905..d115b04 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ The [Essentials](https://github.com/PepperDash/Essentials) libraries are require To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository: `nuget install .\packages.config -OutputDirectory .\packages -excludeVersion`. +Alternatively, you can simply run the `GetPackages.bat` file. To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it. ### Installing Different versions of PepperDash Core @@ -37,7 +38,7 @@ If you need a different version of PepperDash Core, use the command `nuget insta ### Instructions for Renaming Solution and Files -See the Task List in Visual Studio for a guide on how to start using the templage. There is extensive inline documentation and examples as well. +See the Task List in Visual Studio for a guide on how to start using the template. There is extensive inline documentation and examples as well. For renaming instructions in particular, see the XML `remarks` tags on class definitions @@ -45,10 +46,13 @@ For renaming instructions in particular, see the XML `remarks` tags on class def ## Generating Nuget Package -In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec-TEMPLATE" +In the solution folder is a file named "PDT.EssentialsPluginTemplate.nuspec" -1. Remove the -TEMPLATE so that the extention is .nuspec. -2. Rename the file to match your plugin solution name -3. Edit the file to include your project specifics including +1. Rename the file to match your plugin solution name +2. Edit the file to include your project specifics including 1. PepperDash.Essentials.Plugin.MakeModel Convention is to use the prefix "PepperDash.Essentials.Plugin" and include the MakeModel of the device. - 2. https://github.com/PepperDash/EssentialsPluginTemplate Change to your url to the project repo \ No newline at end of file + 2. https://github.com/PepperDash/EssentialsPluginTemplate Change to your url to the project repo + +There is no longer a requirement to adjust workflow files for nuget generation for private and public repositories. This is now handled automatically in the workflow. + +__If you do not make these changes to the nuspec file, the project will not generate a nuget package__ \ No newline at end of file