From 0d5fcb456070bcae341e32a142a2022bb0687d46 Mon Sep 17 00:00:00 2001 From: freddydk Date: Sat, 6 Jan 2024 12:05:14 +0100 Subject: [PATCH] update readme --- .github/workflows/generateNuGet.yml | 8 ++++---- README.md | 29 ++++++++++++++++++++++------- 2 files changed, 26 insertions(+), 11 deletions(-) diff --git a/.github/workflows/generateNuGet.yml b/.github/workflows/generateNuGet.yml index 2afe1a2..eebcbd3 100644 --- a/.github/workflows/generateNuGet.yml +++ b/.github/workflows/generateNuGet.yml @@ -4,10 +4,6 @@ name: Generate NuGet Packages on: workflow_dispatch: inputs: - apps: - description: Comma separated list of apps (leave empty to use APPS secret) - required: false - default: '' nuGetServerUrl: description: NuGet server URL (leave empty to use NUGETSERVERURL variable) required: false @@ -16,6 +12,10 @@ on: description: NuGet auth token (leave empty to use NUGETTOKEN secret) required: false default: '' + apps: + description: Comma separated list of apps (leave empty to use APPS secret) + required: false + default: '' jobs: GenerateNuGetPackages: diff --git a/README.md b/README.md index eee7071..8a30b2a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ It is NOT supported to put both these types of BcNuGet packages on the same NuGe ## Prerequisites +You need to have a direct download URL to the apps you want to create BcNuGet packages for. For testing purposes, you can use this URL: `https://github.com/microsoft/bcsamples-bingmaps.pte/releases/download/6.0.0/bcsamples-bingmaps.pte-main-Apps-5.1.23.0.zip`, which points to a release in the public BingMaps.PTE repository. The URL can contain a SAS token if private. + + You need a NuGet Server where you can place your BcNuGet packages. Thìs tool supports 3 options: 1. nuget.org (public only) 2. GitHub (private only) @@ -54,18 +57,30 @@ In order to push new packages and package versions, you need to create a Persona ### Using Azure DevOps -## Running the +## Running the tool -In order to run this tool, you need to create a fork in your own organization or in your personal GitHub account. +In order to run this tool, you need to create a fork in your own organization or in your personal GitHub account and under actions, enable workflows in the fork. -## Run the tool +Running the **Generate NuGet Packages** workflow will generate BcNuGet packages with full apps. +Running the **Generate Runtime NuGet Packages** workflow will generate BcNuGet packages with runtime packages of your apps. +Mandatory fields are **nuGetServerUrl**, **nuGetToken** and **apps**. Parameters can be specified in the UI or created as secrets and variables, but they can also be provided as parameters when invoking the workflow from code. +Example on how I created full packages in [https://github.com/FreddyKristiansen-Apps/BingMapsPTE](https://github.com/FreddyKristiansen-Apps/BingMapsPTE) -### Step-by-step +```powershell +$apps = 'https://github.com/microsoft/bcsamples-bingmaps.pte/releases/download/6.0.0/bcsamples-bingmaps.pte-main-Apps-5.1.23.0.zip' +$nuGetServerUrl = 'https://github.com/FreddyKristiansen-Apps/BingMapsPTE' +$nuGetToken = '' +gh workflow run --repo freddydk/GenerateBcNuGet "Generate NuGet Packages" -f apps=$apps -f nuGetServerUrl=$nuGetServerUrl -f nuGetToken=$nuGetToken +``` -1. Fork this repository to your personal or organizational account -2. -Follow this fairly simple process to get started: +Example on how I created runtime packages in [https://github.com/FreddyKristiansen-RuntimePackages/BingMapsPTE](https://github.com/FreddyKristiansen-RuntimePackages/BingMapsPTE) +```powershell +$apps = 'https://github.com/microsoft/bcsamples-bingmaps.pte/releases/download/6.0.0/bcsamples-bingmaps.pte-main-Apps-5.1.23.0.zip' +$nuGetServerUrl = 'https://github.com/FreddyKristiansen-RuntimePackages/BingMapsPTE' +$nuGetToken = '' +gh workflow run --repo freddydk/GenerateBcNuGet "Generate Runtime NuGet Packages" -f apps=$apps -f nuGetServerUrl=$nuGetServerUrl -f nuGetToken=$nuGetToken -f country=w1 +```