Skip to content

Commit

Permalink
update paths
Browse files Browse the repository at this point in the history
  • Loading branch information
qdraw committed Mar 21, 2024
1 parent 8ac85c6 commit 7842776
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 54 deletions.
101 changes: 50 additions & 51 deletions documentation/docs/developer-guide/github-actions/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ Build, test, and deploy your code right from GitHub.

## Important pipelines

- [Build desktop app (Create Desktop Release on tag for .Net Core and Electron)](#create-desktop-release-on-tag-for-net-core-and-electron)
- [Docker Hub on new version (Create Release on tag for docker hub)](#create-release-on-tag-for-docker-hub)
- [Docker unstable build (Docker buildx multi-arch CI unstable master)](#docker-buildx-multi-arch-ci-unstable-master)

- [Build desktop app (Create Desktop Release on tag for .Net Core and Electron)](#create-desktop-release-on-tag-for-net-core-and-electron)
- [Docker Hub on new version (Create Release on tag for docker hub)](#create-release-on-tag-for-docker-hub)
- [Docker unstable build (Docker buildx multi-arch CI unstable master)](#docker-buildx-multi-arch-ci-unstable-master)

## Table of Contents

Expand All @@ -35,59 +34,59 @@ Build, test, and deploy your code right from GitHub.
15. [End-to-End on Windows CI](#end2end-on-windows-ci)
16. [Create Release on tag for Docker Hub](#create-release-on-tag-for-docker-hub)



# All github actions used by this project

There are multiple github actions used by this project. Bellow is a list of all github actions and a short on alphabet order.
There are multiple github actions used by this project. Bellow is a list of all github actions and a
short on alphabet order.

## Auto upgrade .NET SDK version

Run weekly
Automatically upgrade the .NET SDK version and upgrade nuget packages file when a new version is released.
Automatically upgrade the .NET SDK version and upgrade nuget packages file when a new version is
released.

[![Dotnet sdk version auto upgrade](https://github.com/qdraw/starsky/actions/workflows/auto-dotnet-sdk-version-upgrade.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/auto-dotnet-sdk-version-upgrade.yml)
[![webapp-update-dotnet-sdk-version-upgrade](https://github.com/qdraw/starsky/actions/workflows/webapp-update-dotnet-sdk-version-upgrade.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/webapp-update-dotnet-sdk-version-upgrade.yml)

```bash
cd starsky-tools/build-tools/
npm run nuget-package-list
```

> [auto-dotnet-sdk-version-upgrade.yml](https://github.com/qdraw/starsky/actions/workflows/auto-dotnet-sdk-version-upgrade.yml)
> [webapp-update-dotnet-sdk-version-upgrade.yml](https://github.com/qdraw/starsky/actions/workflows/webapp-update-dotnet-sdk-version-upgrade.yml)
## Application Version Auto update

Run on push and manual trigger
Upgrade the application version in the csproj file and package.json file

[![Application Version Auto update](https://github.com/qdraw/starsky/actions/workflows/auto-update-application-version.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/auto-update-application-version.yml)
[![global-update-application-version-auto](https://github.com/qdraw/starsky/actions/workflows/global-update-application-version-auto.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/global-update-application-version-auto.yml)

```bash
cd starsky-tools/build-tools/
npm run app-version-update
```

> [auto-update-application-version.yml](https://github.com/qdraw/starsky/actions/workflows/auto-update-application-version.yml)
> [global-update-application-version-auto.yml](https://github.com/qdraw/starsky/actions/workflows/global-update-application-version-auto.yml)
## Auto update Nuget packages list

On push on master branch
Creates a list of nuget packages and their version in the nuget-package-list file

[![Auto update Nuget packages list](https://github.com/qdraw/starsky/actions/workflows/auto-update-nuget-packages-list.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/auto-update-nuget-packages-list.yml)
[![webapp-update-nuget-packages-list](https://github.com/qdraw/starsky/actions/workflows/webapp-update-nuget-packages-list.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/webapp-update-nuget-packages-list.yml)

```bash
cd starsky-tools/build-tools/
npm run nuget-package-list
```

> [auto-update-nuget-packages-list.yml](https://github.com/qdraw/starsky/actions/workflows/auto-update-nuget-packages-list.yml)
> [webapp-update-nuget-packages-list.yml](https://github.com/qdraw/starsky/actions/workflows/webapp-update-nuget-packages-list.yml)
## Auto Update Swagger

Update json file with the latest swagger file

[![Auto Update Swagger](https://github.com/qdraw/starsky/actions/workflows/auto-update-swagger-dotnet.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/auto-update-swagger-dotnet.yml)
[![webapp-update-swagger-dotnet](https://github.com/qdraw/starsky/actions/workflows/webapp-update-swagger-dotnet.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/webapp-update-swagger-dotnet.yml)

```bash
cd starsky/starsky
Expand All @@ -100,40 +99,40 @@ cd starsky-tools/build-tools/
npm run nuget-package-list
```

> [auto-update-swagger-dotnet.yml](https://github.com/qdraw/starsky/actions/workflows/auto-update-swagger-dotnet.yml)
> [webapp-update-swagger-dotnet.yml](https://github.com/qdraw/starsky/actions/workflows/webapp-update-swagger-dotnet.yml)
## auto clientapp create Vite upgrade

Bootstrap the client app with the latest Vite version

[![auto clientapp create react app upgrade](https://github.com/qdraw/starsky/actions/workflows/auto-upgrade-clientapp-create-react-app.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/auto-upgrade-clientapp-create-react-app.yml)
[![clientapp-update-dependencies-vite](https://github.com/qdraw/starsky/actions/workflows/clientapp-update-dependencies-vite.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/clientapp-update-dependencies-vite.yml)

```bash
cd starsky-tools/build-tools/
npm run clientapp-create-react-app-update
```

> [auto-upgrade-clientapp-create-react-app.yml](https://github.com/qdraw/starsky/actions/workflows/auto-upgrade-clientapp-create-react-app.yml)
> [clientapp-update-dependencies-vite.yml](https://github.com/qdraw/starsky/actions/workflows/clientapp-update-dependencies-vite.yml)
## Auto Documentation create Docusaurus upgrade

Bootstrap the docs with the latest Docusaurus version

[![Auto Documentation create Docusaurus upgrade](https://github.com/qdraw/starsky/actions/workflows/auto-upgrade-documentation-create-docusaurus.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/auto-upgrade-documentation-create-docusaurus.yml)
[![documentation-update-dependencies-create-docusaurus](https://github.com/qdraw/starsky/actions/workflows/documentation-update-dependencies-create-docusaurus.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/documentation-update-dependencies-create-docusaurus.yml)

```bash
cd starsky-tools/build-tools/
npm run documentation-create-docusaurus-update
```

> [auto-upgrade-documentation-create-docusaurus.yml](https://github.com/qdraw/starsky/actions/workflows/auto-upgrade-documentation-create-docusaurus.yml)
> [documentation-update-dependencies-create-docusaurus.yml](https://github.com/qdraw/starsky/actions/workflows/documentation-update-dependencies-create-docusaurus.yml)
## ClientApp React Linux CI

Build for the ClientApp on linux
Runs on pull request and push on the master branch

[![ClientApp React Linux CI](https://github.com/qdraw/starsky/actions/workflows/clientapp-react-linux-ci.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/clientapp-react-linux-ci.yml)
[![clientapp-react-linux-ci](https://github.com/qdraw/starsky/actions/workflows/clientapp-react-linux-ci.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/clientapp-react-linux-ci.yml)

```bash
cd starsky/starsky/clientapp
Expand Down Expand Up @@ -164,16 +163,16 @@ npm run test:ci

Run CodeQL analysis on push and pull request

[![end2end on ubuntu-ci](https://github.com/qdraw/starsky/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/codeql-analysis.yml)
[![global-codeql-analysis](https://github.com/qdraw/starsky/actions/workflows/global-codeql-analysis.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/global-codeql-analysis.yml)


> [codeql-analysis.yml](https://github.com/qdraw/starsky/actions/workflows/codeql-analysis.yml)
> [global-codeql-analysis.yml](https://github.com/qdraw/starsky/actions/workflows/global-codeql-analysis.yml)
## Documentation to github pages

Deploy docs site to github pages

[![end2end on ubuntu-ci](https://github.com/qdraw/starsky/actions/workflows/documentation-gh-pages.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/documentation-gh-pages.yml)
[![documentation-gh-pages](https://github.com/qdraw/starsky/actions/workflows/documentation-gh-pages.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/documentation-gh-pages.yml)


> [documentation-gh-pages.yml](https://github.com/qdraw/starsky/actions/workflows/documentation-gh-pages.yml)
Expand All @@ -182,7 +181,8 @@ Deploy docs site to github pages

Cypress end to end testing on ubuntu ci
Runs a systemd service and a cypress test.
See [Cypress Dashboard](https://cloud.cypress.io/projects/1yeai3/runs) and click on the tag: `ubuntu-ci` for more details.
See [Cypress Dashboard](https://cloud.cypress.io/projects/1yeai3/runs) and click on the
tag: `ubuntu-ci` for more details.

[![end2end on ubuntu-ci](https://github.com/qdraw/starsky/actions/workflows/end2end-ubuntu-ci.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/end2end-ubuntu-ci.yml)

Expand All @@ -192,7 +192,8 @@ See [Cypress Dashboard](https://cloud.cypress.io/projects/1yeai3/runs) and click

Cypress end to end testing on windows ci
Runs a windows service and a cypress test.
See [Cypress Dashboard](https://cloud.cypress.io/projects/1yeai3/runs) and click on the tag: `windows-ci` for more details.
See [Cypress Dashboard](https://cloud.cypress.io/projects/1yeai3/runs) and click on the
tag: `windows-ci` for more details.

[![end2end on windows-ci](https://github.com/qdraw/starsky/actions/workflows/end2end-windows-ci.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/end2end-windows-ci.yml)

Expand All @@ -203,83 +204,81 @@ See [Cypress Dashboard](https://cloud.cypress.io/projects/1yeai3/runs) and click
On tag push create a release for docker hub
runs on release of a new stable version

[![Create Release on tag for docker hub](https://github.com/qdraw/starsky/actions/workflows/release-on-tag-docker-hub.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/release-on-tag-docker-hub.yml)
[![webapp-docker-release-on-tag-docker-hub](https://github.com/qdraw/starsky/actions/workflows/webapp-docker-release-on-tag-docker-hub.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/webapp-docker-release-on-tag-docker-hub.yml)

> [release-on-tag-docker-hub.yml](https://github.com/qdraw/starsky/actions/workflows/release-on-tag-docker-hub.yml)
> [webapp-docker-release-on-tag-docker-hub.yml](https://github.com/qdraw/starsky/actions/workflows/webapp-docker-release-on-tag-docker-hub.yml)
## Create Desktop Release on tag for .Net Core and Electron
## Create Desktop Release on tag for .Net and Electron

Build the .NET runtime for Linux, Windows and Mac OS
And build Electron
Only create release when a new tag is pushed

[![Create Release on tag for docker hub](https://github.com/qdraw/starsky/actions/workflows/release-on-tag-netcore-desktop-electron.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/release-on-tag-netcore-desktop-electron.yml)
[![desktop-release-on-tag-net-electron](https://github.com/qdraw/starsky/actions/workflows/desktop-release-on-tag-net-electron.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/desktop-release-on-tag-net-electron.yml)

> [release-on-tag-netcore-desktop-electron.yml](https://github.com/qdraw/starsky/actions/workflows/release-on-tag-netcore-desktop-electron.yml)
> [desktop-release-on-tag-net-electron.yml](https://github.com/qdraw/starsky/actions/workflows/desktop-release-on-tag-net-electron.yml)
## Docker buildx multi-arch CI unstable master

Build docker images for testing

[![Docker buildx multi-arch CI unstable master](https://github.com/qdraw/starsky/actions/workflows/starsky-docker-buildx.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/starsky-docker-buildx.yml)
[![webapp-unstable-docker-buildx](https://github.com/qdraw/starsky/actions/workflows/webapp-unstable-docker-buildx.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/webapp-unstable-docker-buildx.yml)

> [starsky-docker-buildx.yml](https://github.com/qdraw/starsky/actions/workflows/starsky-docker-buildx.yml)
> [webapp-unstable-docker-buildx.yml](https://github.com/qdraw/starsky/actions/workflows/starsky-docker-buildx.yml)
## Starsky .NET Core (Ubuntu)
## Starsky .NET (Ubuntu)

CI build for .NET Core on Ubuntu
Builds and runs unit tests in international mode and locale NL_nl due dot and comma issues

[![Docker buildx multi-arch CI unstable master](https://github.com/qdraw/starsky/actions/workflows/starsky-dotnetcore-ubuntu.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/starsky-dotnetcore-ubuntu.yml)
[![webapp-build-net-ubuntu](https://github.com/qdraw/starsky/actions/workflows/webapp-build-net-ubuntu.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/webapp-build-net-ubuntu.yml)


> [starsky-dotnetcore-ubuntu.yml](https://github.com/qdraw/starsky/actions/workflows/starsky-dotnetcore-ubuntu.yml)
> [webapp-build-net-ubuntu](https://github.com/qdraw/starsky/actions/workflows/webapp-build-net-ubuntu.yml)
## Starsky .NET Core (Windows)

CI build for .NET Core on Windows
Builds and runs unit tests

[![Docker buildx multi-arch CI unstable master](https://github.com/qdraw/starsky/actions/workflows/starsky-dotnetcore-windows.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/starsky-dotnetcore-windows.yml)
[![webapp-build-net-windows](https://github.com/qdraw/starsky/actions/workflows/webapp-build-net-windows.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/webapp-build-net-windows.yml)

> [starsky-dotnetcore-windows.yml](https://github.com/qdraw/starsky/actions/workflows/starsky-dotnetcore-windows.yml)
> [webapp-build-net-windows.yml](https://github.com/qdraw/starsky/actions/workflows/webapp-build-net-windows.yml)
## Starsky SonarQube ClientApp NetCore Analyze PR

Analyze the code with SonarQube on Pull Request

[![Docker buildx multi-arch CI unstable master](https://github.com/qdraw/starsky/actions/workflows/starsky-sonarqube-clientapp-netcore.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/starsky-sonarqube-clientapp-netcore.yml)
[![webapp-sonarqube-clientapp-netcore](https://github.com/qdraw/starsky/actions/workflows/webapp-sonarqube-clientapp-netcore.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/webapp-sonarqube-clientapp-netcore.yml)

> [starsky-sonarqube-clientapp-netcore.yml](https://github.com/qdraw/starsky/actions/workflows/starsky-sonarqube-clientapp-netcore.yml)
> [webapp-sonarqube-clientapp-netcore.yml](https://github.com/qdraw/starsky/actions/workflows/webapp-sonarqube-clientapp-netcore.yml)
## Starsky Tools Node smoke test

Smoke tests for the starsky-tools

- dropbox import
- localtunnel
- mail
- mock service
- thumbnail
- dropbox import
- localtunnel
- mail
- mock service
- thumbnail

[![Docker buildx multi-arch CI unstable master](https://github.com/qdraw/starsky/actions/workflows/starsky-tools-node-smoke-test.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/starsky-tools-node-smoke-test.yml)
[![tools-smoke-test-node](https://github.com/qdraw/starsky/actions/workflows/tools-smoke-test-node.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/tools-smoke-test-node.yml)

> [starsky-tools-node-smoke-test.yml](https://github.com/qdraw/starsky/actions/workflows/starsky-tools-node-smoke-test.yml)
> [tools-smoke-test-node.yml](https://github.com/qdraw/starsky/actions/workflows/tools-smoke-test-node.yml)
## starskyDesktop Electron PR (Missing .NET dependency)

Build the Electron app on pull request without .NET so faster but does not run the app
For Windows and Mac OS builds the app and runs the unit tests

[![Docker buildx multi-arch CI unstable master](https://github.com/qdraw/starsky/actions/workflows/desktop-electron-pr-build-mac-win.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/desktop-electron-pr-build-mac-win.yml)
[![desktop-electron-pr-build-mac-win](https://github.com/qdraw/starsky/actions/workflows/desktop-electron-pr-build-mac-win.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/desktop-electron-pr-build-mac-win.yml)

> [desktop-electron-pr-build-mac-win.yml](https://github.com/qdraw/starsky/actions/workflows/desktop-electron-pr-build-mac-win.yml)
## storybook clientapp netlify

Deploy storybook of clientapp to netlify

[![Docker buildx multi-arch CI unstable master](https://github.com/qdraw/starsky/actions/workflows/storybook-clientapp-netlify.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/storybook-clientapp-netlify.yml)

[![clientapp-storybook-netlify](https://github.com/qdraw/starsky/actions/workflows/clientapp-storybook-netlify.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/clientapp-storybook-netlify.yml)

> [storybook-clientapp-netlify.yml](https://github.com/qdraw/starsky/actions/workflows/storybook-clientapp-netlify.yml)
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The pipeline below is to test the Desktop build process. The .NET part isn't bui

A full build including the .NET dependency

[![Create Desktop Release on tag for .Net Core and Electron](https://github.com/qdraw/starsky/actions/workflows/release-on-tag-netcore-desktop-electron.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/release-on-tag-netcore-desktop-electron.yml)
[![Create Desktop Release on tag for .Net Core and Electron](https://github.com/qdraw/starsky/actions/workflows/desktop-release-on-tag-net-electron.yml/badge.svg)](https://github.com/qdraw/starsky/actions/workflows/desktop-release-on-tag-net-electron.yml)

_See [the documentation](https://docs.qdraw.nl/docs/developer-guide/github-actions/) for details_

Expand Down
2 changes: 1 addition & 1 deletion starsky/starsky/github-artifacts-download.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

param(
[Parameter(Mandatory=$false)][switch]$help,
[Parameter(Mandatory=$false)][string]$workFlowId="release-on-tag-netcore-desktop-electron.yml",
[Parameter(Mandatory=$false)][string]$workFlowId="desktop-release-on-tag-net-electron.yml",
[Parameter(Mandatory=$false)][string]$runTime='',
[Parameter(Mandatory=$false)][string]$outPut='',
[Parameter(Mandatory=$false)][string]$token=$env:STARSKY_GITHUB_PAT
Expand Down
2 changes: 1 addition & 1 deletion starsky/starsky/github-artifacts-download.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

# source: /opt/starsky/starsky/github-artifacts-download.sh

WORKFLOW_ID="release-on-tag-netcore-desktop-electron.yml"
WORKFLOW_ID="desktop-release-on-tag-net-electron.yml"

# default will be overwritten
RUNTIME="linux-arm"
Expand Down

0 comments on commit 7842776

Please sign in to comment.