From 2935f3cb4a62b4beaf334ef83803059aaa944a82 Mon Sep 17 00:00:00 2001 From: Sebastian Ziebell Date: Mon, 28 Oct 2024 13:27:22 +0100 Subject: [PATCH 1/2] Adjust instructions in Readme * update information on how to create a token * add information on how to copy or use the workflow file --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1082969..ba3bd9d 100644 --- a/README.md +++ b/README.md @@ -41,9 +41,10 @@ Some highlights about CriticalUp and the project manifest: ### Get the CriticalUp Token to authenticate -- To install any Ferrocene product/toolchain, you will need to get a token from the [Ferrocene Customer Portal]. This token can be created by you or your organization's liason admin. +- To install any Ferrocene product/toolchain, you will need to get a token from the [Ferrocene Customer Portal]. + This token can be created in your account. - The tokens are at the [Ferrocene CriticalUp Tokens] section of the portal. - - Once you are on the page, click "New Token" and copy the token. + - Once you are on the page, click "New Token", provide a memorable title for it, and once generated copy the token. - The token is only shown once for security. ### Add the CriticalUp Token to GitHub Action secrets @@ -58,9 +59,12 @@ The CriticalUp Token you got from the [Ferrocene Customer Portal] must be set in ### Create a simple GitHub Action -You can see the [`build.yml`] file for a fully working sample for this demo project. +An example of a fully working Github CI workflow file can be found in the workflow file [`build.yml`] of this demo project. -- We will use a single job so we don't need to cache anything. The job will have multiple steps. +- When no workflow file in your project exists, copy the `build.yml` into the folder `.github/workflows`, otherwise + copy the CI job `install-criticalup-build-run-my-app` into your existing workflow file. +- Adapt the workflow if necessary, for example to compile the project instead of run it. +- We will use a single job so we don't need to cache anything. The job consists of multiple steps. - We will showcase only Ubuntu 20.04 in this exercise. #### Install CriticalUp From ed45ae31d2c5a475a18bec9ff00bf79aa0acaaeb Mon Sep 17 00:00:00 2001 From: Sebastian Ziebell Date: Mon, 28 Oct 2024 13:30:02 +0100 Subject: [PATCH 2/2] Fix formating --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ba3bd9d..45230ee 100644 --- a/README.md +++ b/README.md @@ -89,10 +89,10 @@ criticalup --help #### Authenticate CriticalUp -_This section assumes you have done the following from above: +**This section assumes you have done the following from above:** - Get the CriticalUp Token to authenticate -- Add the CriticalUp Token to GitHub Action secrets_ +- Add the CriticalUp Token to GitHub Action secrets In your GitHub Action you can use the secret now as: @@ -104,9 +104,9 @@ criticalup auth set ${{ secrets.CRITICALUP_TOKEN }} #### Install Ferrocene toolchain -_This step assumes you have already done the following from above: +**This step assumes you have already done the following from above:** -- Add a project manifest to your repo_ +- Add a project manifest to your repo Just running the following command will install the toolchain listed in your project manifest (`criticalup.toml`).