Skip to content
62 changes: 2 additions & 60 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,69 +7,11 @@

An opinionated template for creating Umbraco packages hosted on GitHub.

> [!IMPORTANT]
> Version 15 will only receive security updates and no new features.
> [!WARNING]
> Version 15 is no longer supported and is End of Life (EOL).

> Please review the [security policy](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate?tab=security-ov-file#supported-versions) for more information.

## Quick Start

### Prerequisites

1. A basic understanding of NuGet package development
- A NuGet API key - [Create an API key](https://learn.microsoft.com/en-us/nuget/nuget-org/publish-a-package)
2. A git repository on GitHub
- Your repository name must match the project name e.g. `Demo.Package`
- [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) - `NUGET_API_KEY`
with your NuGet API key

3. Install template

```powershell
dotnet new install jcdcdev.Umbraco.PackageTemplate
```

### Create package

1. Create new project

#### dotnet CLI

```powershell
dotnet new jcdcdev-umb-package -o Demo.Package --ghUsername jcdcdev --title "My Demo Package" --description "An empty Umbraco package" --addClient
```

#### Visual Studio
- Open Visual Studio
- Create a new project
- Search for `jcdcdev-umb-package`
- Click `Next`
- Fill in the project title, description, and other details
- Click `Create`

2. Open project in your IDE
3. Build and run project
4. Congratulations! You have created an empty Umbraco package 🎉

Now you can implement your package features.

1. Update `README.md` with your package details
2. Update `umbraco-marketplace.json` with your package details

### Publish

1. Push your code to GitHub
2. Create a pull request into the `main` branch
3. Merge the pull request
4. A new release will be created

## Configuration

## Template Parameters

[Documentation](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate?tab=readme-ov-file#template-parameters)


## Contributing

Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/contribute) page.
Expand Down
5 changes: 3 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@ The following table outlines the versions of the project that are currently supp
| Package Version | Umbraco Version | Security Phase Start | End of Life |
| ---------------------------------------------------------------------------------- | --------------- | -------------------- | ----------- |
| [13.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v13) | 13 | 2025-12-14 | 2026-12-14 |
| [15.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v15) | 15 | 2025-08-14 | 2025-11-14 |
| [16.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v16) | 16 | 2026-03-12 | 2026-06-12 |
| [16.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v16) | 16 | 2026-03-12 | 2026-06-12 |
| [17.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v17) | 17 | 2027-11-27 | 2028-11-27 |
## Unsupported Versions

| Package Version | Umbraco Version | End of Life |
| ---------------------------------------------------------------------------------- | --------------- | ----------- |
| [10.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v10) | 10 | 2025-06-16 |
| [12.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v12) | 12 | 2024-06-29 |
| [14.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v14) | 14 | 2025-05-30 |
| [15.x](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/tree/v15) | 15 | 2025-11-14 |


## Future Support
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"lit": "^3.3.1"
},
"devDependencies": {
"@hey-api/openapi-ts": "^0.86.1",
"@hey-api/openapi-ts": "^0.87.1",
"@umbraco-cms/backoffice": "^15.4.4",
"typescript": "^5.9.3",
"vite": "^7.1.11"
Expand Down
Loading