Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pipeline documentation #18

Merged
merged 12 commits into from
Mar 4, 2024
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ The newest build of the shop is deployed [here](https://zeiss.github.io/angular-

To get a better understanding of the style guide example, it is recommended to look into the style guide which is hosted under the repositories [wiki page](https://github.com/ZEISS/angular-styleguide/wiki).

Furthermore, you can find more information about the build and deployment process [here](documentation/generated-documents/build-pipeline-documentation.png).
ssaring marked this conversation as resolved.
Show resolved Hide resolved

Almost the entire app is implemented by using the [Standalone Components](https://angular.io/guide/standalone-components) approach. To cover also the classical module-based approach and to showcase the integration of both concepts, the package `catalog` is implemented module-based completely.

## Development server
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions documentation/pipeline-documentation.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/'
ssaring marked this conversation as resolved.
Show resolved Hide resolved
This document describes the workflow of the deployment process
'/
@startuml Build, Test & Trigger Deploy

|Build and Deploy|
start
note right: Changes pushed to github

partition Build #lightBlue{
:Setting up node;
:Install dependencies;
:Install playwright;
:Build application prod version;
:Run unit tests;
:Run Playwright E2E tests;
:Run WebdriverIO E2E tests;
if (Build successful?) then (No))
repeat: fix errors
repeat while (Build successful?) is (no) not (yes)
endif
}

|Review|
partition Review_Process #lightYellow{
:Review process;
if (Review successfully?) then (No)
repeat: fix findings
repeat while (Review successfully?) is (no) not (yes)
endif
:Merge to main;
}

|Build and Deploy|
partition Deployment #lightGreen {
:Deploy recent build and push it to branch 'gh-pages';
:This will trigger the action 'pages build & deployment' to host the recent build;
ssaring marked this conversation as resolved.
Show resolved Hide resolved
}
end
note right: End of pipeline
@enduml
Loading