Compare commits

..

8 Commits

Author SHA1 Message Date
Jonathan Arndt
52a14c1f3a docs: update cleanup section with detailed file structure example 2025-05-27 08:48:03 -07:00
Jonathan Arndt
bb991544c4 docs: add checklist items for upgrade-to-4-series.md 2025-05-25 15:03:13 -07:00
Jonathan Arndt
663f2483b3 docs: 📝 Add readme.md for guidance to upgrade plugins v1 to v2 or 4series. 2025-05-22 17:14:29 -07:00
Jason DeVito
ba5d0f33a6 Merge pull request #32 from PepperDash/hotfix/robot-docs
fix: Update README workflow to use main branch and correct author/company names in Directory.Build.props
2025-05-21 11:36:01 -05:00
Jonathan Arndt
4283fb2abd fix: Update README workflow to use main branch and correct author/company names in Directory.Build.props 2025-05-21 09:31:49 -07:00
Andrew Welker
4ee211576f Merge pull request #30 from PepperDash/4series-csproj-updates
Update epi-make-model.4Series.csproj
2025-03-25 16:19:46 -05:00
Jason DeVito
952d5b61a4 Update epi-make-model.4Series.csproj
Update PepperDash Essentials version to 2.0.0
2025-03-25 15:54:31 -05:00
Jason DeVito
3f2ef80877 Update epi-make-model.4Series.csproj
Update 4Series.csproj to exlcude assets and change local bid output path.
2025-03-25 10:53:56 -05:00
9 changed files with 121 additions and 9 deletions

View File

@@ -8,7 +8,7 @@ on:
jobs:
call-update-readme:
uses: PepperDash/workflow-templates/.github/workflows/update-readme.yml@development
uses: PepperDash/workflow-templates/.github/workflows/update-readme.yml@main
with:
target-branch: ${{ github.ref_name }}

View File

@@ -0,0 +1,110 @@
![PepperDash Essentials Plugin Logo](/images/essentials-plugin-blue.png)
# Upgrading an EPI: Essentials v1.x → v2.x
## Preparation
1. **Clone the Template Repo referred to as TR** to your local machine.
- [EssentialsPluginTemplate](https://github.com/PepperDash/EssentialsPluginTemplate)
2. **Checkout `main` branch** in the TR.
## Branching
4. In your EPI repo:
- Confirm it does **not already support Essentials v2.x**.
- Ensure there is **no existing 4-series update branch**.
- Create a new branch (e.g., `feature/4-series-updates`) from `main`.
## Upgrade Steps
5. In the new branch:
- **Replace** EPI `.github` files/folders with those from TR as needed.
- *Note:* Retain any custom workflows if required. Consult with PepperDash Team if unsure.
- **Copy** the following from TR to EPI:
- `.releaserc.json` (root)
- `epi-make-model.4Series.sln` (root)
- `src/epi-make-model.4Series.csproj` (create `src` folder if missing)
- `images` folder (if your `readme.md` lacks the standard logo)
- **Initial Commit:** Commit changes, but do **not** push yet.
6. **If EPI has a `src/*.nuspec` file:**
- Record these values from `Nuspec` for later:
- `<id>` (Package ID)
- `<projectUrl>` (Project URL)
- `<title>` (Assembly Title)
7. **Open Solution:**
- Open `epi-make-model.4Series.sln` in Visual Studio 2022.
- If errors occur, ensure the `.csproj` file is located within `src` folder.
8. **Update Project Properties:**
- In `src/epi-make-model.4Series.csproj`, update:
- `AssemblyTitle` (from nuspec `<title>`)
- `RootNamespace` (from existing EPI, device namespace actual)
- `PackageProjectUrl` (from nuspec `<projectUrl>`)
- **Rename `make-model` build path references shown below:**
![defineBuildObjectstoRemove](/images/upgrade-to-4Series/removeObsoleteReferences.png)
- **Add runtime exclusion:**
Add `<ExcludeAssets>runtime</ExcludeAssets>` to the PepperDash Essentials `PackageReference`.
![addRuntimeExclusion](/images/upgrade-to-4Series/addRuntumeExclusion.png)
9. **Copy Build Files:**
- Copy `src/Directory.Build.props` and `src/Directory.Build.targets` from TR.
- Update `RepositoryUrl` in `Directory.Build.props` to match nuspec `PackageProjectUrl`.
- Remove "template" text from `<Product>` in `Directory.Build.props` as needed.
10. **Clean Up:**
- Delete old Visual Studio 2008 files: `.sln`, `.suo`, `.nuspec`, `.csproj`, `.csproj.user`, `.projectinfo`.
- Ensure file structure matches below example:
```
├── src/
│ ├── Directory.Build.props
│ ├── Directory.Build.tagets
│ ├── *.3Series.csproj
│ └── *.4Series.csproj
├── .releaserc.json
├── *.3Series.sln
├── *.4Series.sln
├── LICENSE.md
└── README.md
```
11. **Rename Solution/Project** as needed.
![renameEpiSolution](/images/upgrade-to-4Series/renameEpiSolution.png)
12. **Update Project References and Dependencies**
- Remove old PepperDash Essentials dependency.
- Add PepperDash Essentials v2.x dependency via Visual Studio 2022 > Project > `Manage Nuget Packages`.
![removeExistingReferences](/images/upgrade-to-4Series/removeExistingDependencies.png)
13. **Update Factory Class:**
Set `MinimumEssentialsFrameworkVersion` to match the Essentials version dependency.
14. **Build Solution:**
Ensure solution compiles (warnings about obsolete `Debug.Console` calls are OK).
15. **Update Debug Calls:**
Replace `Debug.Console` with `Debug.Log` methods as appropriate (see table).
![replaceDebugConsoleMethods](/images/upgrade-to-4Series/replaceExistingDebugConsoleMethods.png)
## Completion Checklist
- [ ] EPI compiles with **no warnings**.
- [ ] **Obsolete methods** updated to modern equivalents.
- [ ] **Workflows** complete successfully; packages generated via GitHub and NuGet.org.
- [ ] `readme.md` includes:
- Usage/setup instructions
- Example SIMPL Windows bridge joinmap
- Example device communication structure/properties
- [ ] EPI tested against full release Essentials version.
- [ ] EPI tested by another developer.
- [ ] Full release of EPI.
---
*For questions about workflows or customizations, consult with PepperDash Team.*

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

View File

@@ -2,14 +2,14 @@
<PropertyGroup>
<Version>1.0.0-local</Version>
<InformationalVersion>$(Version)</InformationalVersion>
<Authors>PepperDash Technologies</Authors>
<Company>PepperDash Technologies</Company>
<Authors>PepperDash Technology</Authors>
<Company>PepperDash Technology</Company>
<Product>PepperDash Essentials Plugin Template</Product>
<Copyright>Copyright © 2025</Copyright>
<RepositoryUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageTags>Crestron; 4series</PackageTags>
<PackageOutputPath>../output</PackageOutputPath>
<PackageOutputPath>..\output</PackageOutputPath>
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
<PackageLicenseFile>LICENSE.md</PackageLicenseFile>
<PackageReadmeFile>README.md</PackageReadmeFile>

View File

@@ -7,14 +7,14 @@
<RootNamespace>PepperDash.Essentials.Plugin</RootNamespace>
<Deterministic>false</Deterministic>
<AssemblyTitle>PepperDash.Essentials.Plugin.Make.Model</AssemblyTitle>
<Company>PepperDash Technologies</Company>
<Company>PepperDash Technology</Company>
<Description>This software is a template for a PepperDash Essentials Plugin.</Description>
<Copyright>Copyright 2025</Copyright>
<Version>1.0.0-local</Version>
<GenerateAssemblyInfo>true</GenerateAssemblyInfo>
<InformationalVersion>$(Version)</InformationalVersion>
<OutputPath>4Series\bin\$(Configuration)\</OutputPath>
<Authors>PepperDash Technologies</Authors>
<OutputPath>bin\$(Configuration)\</OutputPath>
<Authors>PepperDash Technology</Authors>
<PackageId>Pepperdash.Essentials.Plugins.Template</PackageId>
<PackageProjectUrl>https://github.com/PepperDash/EssentialsPluginTemplate.git</PackageProjectUrl>
<PackageTags>crestron 4series essentials plugin template</PackageTags>
@@ -35,7 +35,9 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="PepperDashEssentials" Version="2.0.0-hotfix-2613" />
<PackageReference Include="PepperDashEssentials" Version="2.0.0" >
<ExcludeAssets>runtime</ExcludeAssets>
</PackageReference>
</ItemGroup>
<ItemGroup>
@@ -45,4 +47,4 @@
<ItemGroup>
<None Remove="../output\epi-make-model.4Series.1.0.0-local.cplz" />
</ItemGroup>
</Project>
</Project>