From a087007eb6733da21b976df70318d15a5afe2acb Mon Sep 17 00:00:00 2001 From: Dimo Dimov <961014+dimodi@users.noreply.github.com> Date: Sat, 15 Feb 2025 10:39:14 +0200 Subject: [PATCH 1/7] docs(common): Improve GitHub Actions license key example syntax --- deployment/ci-cd-license-key.md | 15 ++++++++++++--- docs-builder.yml | 2 ++ 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/deployment/ci-cd-license-key.md b/deployment/ci-cd-license-key.md index 71a2b7ec9..8d59332fe 100644 --- a/deployment/ci-cd-license-key.md +++ b/deployment/ci-cd-license-key.md @@ -45,11 +45,20 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet 1. Create a new Repository Secret or an Organization Secret. 1. Set the name of the secret to `TELERIK_LICENSE` and paste the contents of the license file as a value. -1. After running `npm install` or `yarn`, add a build step to activate the license: - ````YAML +1. Add a `TELERIK_LICENSE` environment variable to the step, which builds the Blazor app: + ````YAML.skip-repl env: - TELERIK_LICENSE: ${ { secrets.TELERIK_LICENSE } } # remove the spaces between the brackets + TELERIK_LICENSE: ${{ secrets_TELERIK_LICENSE }} ```` + As a result, the whole step may look similar to: + ````YAML.skip-repl + - name: Build with dotnet + run: dotnet build -c Release + env: + TELERIK_LICENSE: ${{ secrets_TELERIK_LICENSE }} + TELERIK_NUGET_KEY: ${{ secrets_TELERIK_NUGET_KEY }} + ```` + (Also see [Using NuGet Keys](slug:deployment-nuget#using-nuget-keys) in the article [Restoring NuGet Packages in Your CI Workflow](slug:deployment-nuget). It shows how to use the `TELERIK_NUGET_KEY` environment variable in your CI build environment.) ### Docker diff --git a/docs-builder.yml b/docs-builder.yml index c74ab3292..170ad51f9 100644 --- a/docs-builder.yml +++ b/docs-builder.yml @@ -30,6 +30,8 @@ liquid-output-delimiter-right: "}}" liquid: uiForBlazorLatestVersion: "8.0.0" themesVersion: "10.2.0" + secrets_TELERIK_NUGET_KEY: "{{ secrets.TELERIK_NUGET_KEY }}" + secrets_TELERIK_LICENSE: "{{ secrets.TELERIK_LICENSE }}" meta: "*templates": From d24437de755272c9df7a3cd41c44b252f8f9b4b0 Mon Sep 17 00:00:00 2001 From: Dimo Dimov <961014+dimodi@users.noreply.github.com> Date: Sat, 15 Feb 2025 11:11:47 +0200 Subject: [PATCH 2/7] refactor --- deployment/ci-cd-license-key.md | 6 +++--- docs-builder.yml | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/deployment/ci-cd-license-key.md b/deployment/ci-cd-license-key.md index 8d59332fe..1846664a2 100644 --- a/deployment/ci-cd-license-key.md +++ b/deployment/ci-cd-license-key.md @@ -48,15 +48,15 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet 1. Add a `TELERIK_LICENSE` environment variable to the step, which builds the Blazor app: ````YAML.skip-repl env: - TELERIK_LICENSE: ${{ secrets_TELERIK_LICENSE }} + TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} ```` As a result, the whole step may look similar to: ````YAML.skip-repl - name: Build with dotnet run: dotnet build -c Release env: - TELERIK_LICENSE: ${{ secrets_TELERIK_LICENSE }} - TELERIK_NUGET_KEY: ${{ secrets_TELERIK_NUGET_KEY }} + TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} + TELERIK_NUGET_KEY: ${{ curly_open }} secrets.TELERIK_NUGET_KEY {{ curly_close }} ```` (Also see [Using NuGet Keys](slug:deployment-nuget#using-nuget-keys) in the article [Restoring NuGet Packages in Your CI Workflow](slug:deployment-nuget). It shows how to use the `TELERIK_NUGET_KEY` environment variable in your CI build environment.) diff --git a/docs-builder.yml b/docs-builder.yml index 170ad51f9..e66b05122 100644 --- a/docs-builder.yml +++ b/docs-builder.yml @@ -30,8 +30,8 @@ liquid-output-delimiter-right: "}}" liquid: uiForBlazorLatestVersion: "8.0.0" themesVersion: "10.2.0" - secrets_TELERIK_NUGET_KEY: "{{ secrets.TELERIK_NUGET_KEY }}" - secrets_TELERIK_LICENSE: "{{ secrets.TELERIK_LICENSE }}" + curly_open: "{{" + curly_close: "}}" meta: "*templates": From 664904c0764be1164d9daef799d7f1a05a8ee4b2 Mon Sep 17 00:00:00 2001 From: Dimo Dimov <961014+dimodi@users.noreply.github.com> Date: Sat, 15 Feb 2025 14:13:14 +0200 Subject: [PATCH 3/7] Add license key to publish step too --- deployment/ci-cd-license-key.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/deployment/ci-cd-license-key.md b/deployment/ci-cd-license-key.md index 1846664a2..86395f17a 100644 --- a/deployment/ci-cd-license-key.md +++ b/deployment/ci-cd-license-key.md @@ -33,30 +33,35 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet ### Azure Pipelines (YAML) -1. Create a new user-defined variable named `TELERIK_LICENSE`. +1. Create a new [user-defined variable](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch) named `TELERIK_LICENSE`. 1. Paste the contents of the license key file as a value. ### Azure Pipelines (Classic) -1. Create a new user-defined variable named `TELERIK_LICENSE`. +1. Create a new [user-defined variable](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=classic%2Cbatch) named `TELERIK_LICENSE`. 1. Paste the contents of the license key file as a value. ### GitHub Actions -1. Create a new Repository Secret or an Organization Secret. +1. Create a new [Repository Secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) or an [Organization Secret](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization). 1. Set the name of the secret to `TELERIK_LICENSE` and paste the contents of the license file as a value. -1. Add a `TELERIK_LICENSE` environment variable to the step, which builds the Blazor app: +1. Add a `TELERIK_LICENSE` environment variable to the steps, which build and publish the Blazor app: ````YAML.skip-repl env: TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} ```` - As a result, the whole step may look similar to: + The resulting workflow steps may look similar to: ````YAML.skip-repl - - name: Build with dotnet + - name: Build Step run: dotnet build -c Release env: - TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} TELERIK_NUGET_KEY: ${{ curly_open }} secrets.TELERIK_NUGET_KEY {{ curly_close }} + TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} + + - name: Publish Step + run: dotnet publish -c Release + env: + TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} ```` (Also see [Using NuGet Keys](slug:deployment-nuget#using-nuget-keys) in the article [Restoring NuGet Packages in Your CI Workflow](slug:deployment-nuget). It shows how to use the `TELERIK_NUGET_KEY` environment variable in your CI build environment.) From a1fd72fe3818176d0d9404457bad8d7d9bd8c689 Mon Sep 17 00:00:00 2001 From: Dimo Dimov <961014+dimodi@users.noreply.github.com> Date: Sat, 15 Feb 2025 14:25:35 +0200 Subject: [PATCH 4/7] Simplify curly syntax --- deployment/ci-cd-license-key.md | 8 ++++---- docs-builder.yml | 2 -- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/deployment/ci-cd-license-key.md b/deployment/ci-cd-license-key.md index 86395f17a..d0a407757 100644 --- a/deployment/ci-cd-license-key.md +++ b/deployment/ci-cd-license-key.md @@ -48,20 +48,20 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet 1. Add a `TELERIK_LICENSE` environment variable to the steps, which build and publish the Blazor app: ````YAML.skip-repl env: - TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} + TELERIK_LICENSE: ${{ "{{ secrets.TELERIK_LICENSE }}" }} ```` The resulting workflow steps may look similar to: ````YAML.skip-repl - name: Build Step run: dotnet build -c Release env: - TELERIK_NUGET_KEY: ${{ curly_open }} secrets.TELERIK_NUGET_KEY {{ curly_close }} - TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} + TELERIK_NUGET_KEY: ${{ "{{ secrets.TELERIK_NUGET_KEY }}" }} + TELERIK_LICENSE: ${{ "{{ secrets.TELERIK_LICENSE }}" }} - name: Publish Step run: dotnet publish -c Release env: - TELERIK_LICENSE: ${{ curly_open }} secrets.TELERIK_LICENSE {{ curly_close }} + TELERIK_LICENSE: ${{ "{{ secrets.TELERIK_LICENSE }}" }} ```` (Also see [Using NuGet Keys](slug:deployment-nuget#using-nuget-keys) in the article [Restoring NuGet Packages in Your CI Workflow](slug:deployment-nuget). It shows how to use the `TELERIK_NUGET_KEY` environment variable in your CI build environment.) diff --git a/docs-builder.yml b/docs-builder.yml index e66b05122..c74ab3292 100644 --- a/docs-builder.yml +++ b/docs-builder.yml @@ -30,8 +30,6 @@ liquid-output-delimiter-right: "}}" liquid: uiForBlazorLatestVersion: "8.0.0" themesVersion: "10.2.0" - curly_open: "{{" - curly_close: "}}" meta: "*templates": From 816b86b6b9a0d902ac93ddad89423b77f3a3915b Mon Sep 17 00:00:00 2001 From: Dimo Dimov <961014+dimodi@users.noreply.github.com> Date: Mon, 17 Feb 2025 16:07:12 +0200 Subject: [PATCH 5/7] Update ci-cd-license-key.md --- deployment/ci-cd-license-key.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/deployment/ci-cd-license-key.md b/deployment/ci-cd-license-key.md index d0a407757..7f8f44ad1 100644 --- a/deployment/ci-cd-license-key.md +++ b/deployment/ci-cd-license-key.md @@ -31,15 +31,10 @@ The license activation process in a CI/CD environment involves the following ste The recommended way to provide your license key to the `Telerik.Licensing` NuGet package in CI/CD environment is to use environment variables. Each CI/CD platform has a different process for setting environment variables. This article lists only some of the most popular examples. -### Azure Pipelines (YAML) +### Azure Pipelines -1. Create a new [user-defined variable](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch) named `TELERIK_LICENSE`. -1. Paste the contents of the license key file as a value. - -### Azure Pipelines (Classic) - -1. Create a new [user-defined variable](https://docs.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=classic%2Cbatch) named `TELERIK_LICENSE`. -1. Paste the contents of the license key file as a value. +1. Create a new [user-defined variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables) named `TELERIK_LICENSE`. +1. Paste the contents of the license key file as a value of the variable. ### GitHub Actions @@ -63,7 +58,7 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet env: TELERIK_LICENSE: ${{ "{{ secrets.TELERIK_LICENSE }}" }} ```` - (Also see [Using NuGet Keys](slug:deployment-nuget#using-nuget-keys) in the article [Restoring NuGet Packages in Your CI Workflow](slug:deployment-nuget). It shows how to use the `TELERIK_NUGET_KEY` environment variable in your CI build environment.) + Also see [Using NuGet Keys](slug:deployment-nuget#using-nuget-keys) in the article [Restoring NuGet Packages in Your CI Workflow](slug:deployment-nuget). It shows how to use the `TELERIK_NUGET_KEY` environment variable in your CI build environment. ### Docker From cab28426ef2995b79dabd0f36316feffb66dc675 Mon Sep 17 00:00:00 2001 From: Dimo Dimov <961014+dimodi@users.noreply.github.com> Date: Mon, 17 Feb 2025 16:51:03 +0200 Subject: [PATCH 6/7] Update ci-cd-license-key.md --- deployment/ci-cd-license-key.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deployment/ci-cd-license-key.md b/deployment/ci-cd-license-key.md index 7f8f44ad1..2bae4f37a 100644 --- a/deployment/ci-cd-license-key.md +++ b/deployment/ci-cd-license-key.md @@ -33,7 +33,7 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet ### Azure Pipelines -1. Create a new [user-defined variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables) named `TELERIK_LICENSE`. +1. Create a new user-defined variable named `TELERIK_LICENSE`, according to your [YAML](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#set-variables-in-pipeline) or [Classic](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=classic%2Cbatch#set-variables-in-pipeline) pipeline setup. 1. Paste the contents of the license key file as a value of the variable. ### GitHub Actions From a747ddd2e17ea3c748496ba4773c747f5d68384e Mon Sep 17 00:00:00 2001 From: Dimo Dimov <961014+dimodi@users.noreply.github.com> Date: Mon, 17 Feb 2025 16:54:00 +0200 Subject: [PATCH 7/7] Update ci-cd-license-key.md --- deployment/ci-cd-license-key.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deployment/ci-cd-license-key.md b/deployment/ci-cd-license-key.md index 2bae4f37a..7b5cc79d8 100644 --- a/deployment/ci-cd-license-key.md +++ b/deployment/ci-cd-license-key.md @@ -33,7 +33,7 @@ The recommended way to provide your license key to the `Telerik.Licensing` NuGet ### Azure Pipelines -1. Create a new user-defined variable named `TELERIK_LICENSE`, according to your [YAML](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#set-variables-in-pipeline) or [Classic](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=classic%2Cbatch#set-variables-in-pipeline) pipeline setup. +1. Create a new [user-defined variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables) named `TELERIK_LICENSE`, according to your [YAML](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#set-variables-in-pipeline) or [Classic](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=classic%2Cbatch#set-variables-in-pipeline) pipeline setup. 1. Paste the contents of the license key file as a value of the variable. ### GitHub Actions