Skip to content

Commit

Permalink
Implement documentation of ci/cd pipeline
Browse files Browse the repository at this point in the history
* fix review findings
  • Loading branch information
Azaraky committed Feb 26, 2024
1 parent ed34614 commit 1774162
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions BUILD_PIPELINE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
![`Build Pipeline`](`documentation/generated-documents/build-pipeline-documentation.png`)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ 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).

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 All @@ -26,6 +24,8 @@ Run `npm run build` to build the project.
The build artifacts will be stored in the `dist/` directory.
Use the `--prod` flag for a production build.

Furthermore, you can find more information about the build and deployment process [here](BUILD_PIPELINE.md).

## Running unit tests

Run `npm test` to execute the unit tests via [Karma](https://karma-runner.github.io).
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion documentation/pipeline-documentation.puml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ endif
|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;
:Trigger the action 'pages build & deployment' to host the recent build;
}
end
note right: End of pipeline
Expand Down

0 comments on commit 1774162

Please sign in to comment.