|
7 | 7 |
|
8 | 8 | An opinionated template for creating Umbraco packages hosted on GitHub. |
9 | 9 |
|
10 | | -> [!IMPORTANT] |
11 | | -> Version 15 will only receive security updates and no new features. |
| 10 | +> [!WARNING] |
| 11 | +> Version 15 is no longer supported and is End of Life (EOL). |
12 | 12 |
|
13 | 13 | > Please review the [security policy](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate?tab=security-ov-file#supported-versions) for more information. |
14 | 14 |
|
15 | | -## Quick Start |
16 | | - |
17 | | -### Prerequisites |
18 | | - |
19 | | -1. A basic understanding of NuGet package development |
20 | | - - A NuGet API key - [Create an API key](https://learn.microsoft.com/en-us/nuget/nuget-org/publish-a-package) |
21 | | -2. A git repository on GitHub |
22 | | - - Your repository name must match the project name e.g. `Demo.Package` |
23 | | - - [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) - `NUGET_API_KEY` |
24 | | - with your NuGet API key |
25 | | - |
26 | | -3. Install template |
27 | | - |
28 | | - ```powershell |
29 | | - dotnet new install jcdcdev.Umbraco.PackageTemplate |
30 | | - ``` |
31 | | -
|
32 | | -### Create package |
33 | | -
|
34 | | -1. Create new project |
35 | | -
|
36 | | - #### dotnet CLI |
37 | | -
|
38 | | - ```powershell |
39 | | - dotnet new jcdcdev-umb-package -o Demo.Package --ghUsername jcdcdev --title "My Demo Package" --description "An empty Umbraco package" --addClient |
40 | | - ``` |
41 | | - |
42 | | - #### Visual Studio |
43 | | - - Open Visual Studio |
44 | | - - Create a new project |
45 | | - - Search for `jcdcdev-umb-package` |
46 | | - - Click `Next` |
47 | | - - Fill in the project title, description, and other details |
48 | | - - Click `Create` |
49 | | -
|
50 | | -2. Open project in your IDE |
51 | | -3. Build and run project |
52 | | -4. Congratulations! You have created an empty Umbraco package 🎉 |
53 | | -
|
54 | | -Now you can implement your package features. |
55 | | -
|
56 | | -1. Update `README.md` with your package details |
57 | | -2. Update `umbraco-marketplace.json` with your package details |
58 | | -
|
59 | | -### Publish |
60 | | -
|
61 | | -1. Push your code to GitHub |
62 | | -2. Create a pull request into the `main` branch |
63 | | -3. Merge the pull request |
64 | | -4. A new release will be created |
65 | | -
|
66 | | -## Configuration |
67 | | -
|
68 | | -## Template Parameters |
69 | | -
|
70 | | -[Documentation](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate?tab=readme-ov-file#template-parameters) |
71 | | -
|
72 | | -
|
73 | 15 | ## Contributing |
74 | 16 |
|
75 | 17 | Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate/contribute) page. |
|
0 commit comments