Skip to content

Commit ff78129

Browse files
eksrhaeksrha
committedFeb 26, 2023
add syncing modules
1 parent 38caca0 commit ff78129

34 files changed

+1390
-6
lines changed
 

‎docs/02-ng-mat-components

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/02-ng-mat-components/01-overview.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Overview
3+
---
4+
5+
import ReadmePartial from '../../README.md';
6+
7+
Angular Material Components from FS DevOps
8+
9+
- **lib type**: Angular
10+
- **docs**: ./ng-mat-components
11+
- **repo**: https://github.com/fullstack-devops/ng-mat-components
12+
- **demo**: https://fullstack-devops.github.io/ng-mat-components
13+
14+
---
15+
16+
<ReadmePartial name="Readme" />

‎docs/02-ng-mat-components/02-fs-nav-frame-module/API.mdx

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
import Tabs from '@theme/Tabs';
2+
import TabItem from '@theme/TabItem';
3+
4+
```typescript
5+
import { FsUiFrameModule } from "@fullstack-devops/ng-mat-components";
6+
```
7+
8+
## References
9+
10+
- demo: https://fullstack-devops.github.io/ng-mat-components/ui-frame
11+
- code example:
12+
[app.component.html](https://github.com/fullstack-devops/ng-mat-components/blob/main/projects/lib-workspace/src/app/app.component.html)
13+
[app.component.ts](https://github.com/fullstack-devops/ng-mat-components/blob/main/projects/lib-workspace/src/app/app.component.ts)
14+
15+
---
16+
17+
## Directives
18+
19+
```bash
20+
.
21+
├── fs-ui-frame
22+
│ └── settings.json
23+
└── fs-calendar-table
24+
└── Dockerfile
25+
```
26+
27+
## Directives
28+
29+
### fs-ui-frame
30+
31+
Selector: `fs-ui-frame`
32+
33+
#### fs-ui-frame-toolbar
34+
35+
Parent Selector: `fs-ui-frame`
36+
37+
Selector: `fs-ui-frame-toolbar`
38+
39+
##### fs-ui-frame-toolbar-title
40+
41+
Parent Selector: `fs-ui-frame-toolbar`
42+
43+
Selector: `fs-ui-frame-toolbar-title`
44+
45+
##### fs-ui-frame-toolbar-center
46+
47+
Parent Selector: `fs-ui-frame-toolbar`
48+
49+
Selector: `fs-ui-frame-toolbar-center`
50+
51+
##### fs-ui-frame-toolbar-side
52+
53+
Parent Selector: `fs-ui-frame-toolbar`
54+
55+
Selector: `fs-ui-frame-toolbar-side`
56+
57+
#### fs-ui-frame-content
58+
59+
Parent Selector: `fs-ui-frame`
60+
61+
Selector: `fs-ui-frame-content`
62+
63+
---
64+
65+
## Examples
66+
67+
### ui-frame in form
68+
69+
<Tabs groupId="ui-frame-01">
70+
<TabItem value="html" label="HTML">
71+
72+
```html
73+
<fs-ui-frame
74+
[frameConfig]="frameConfig"
75+
[navUser]="navUser"
76+
[appRoutes]="appRoutes"
77+
(event)="onEvent($event)">
78+
<fs-ui-frame-toolbar>
79+
<fs-ui-frame-toolbar-title>Current App Title</fs-ui-frame-toolbar-title>
80+
81+
<fs-ui-frame-toolbar-center>
82+
<button mat-icon-button>
83+
<mat-icon>help</mat-icon>
84+
</button>
85+
<button mat-icon-button matBadge="3">
86+
<mat-icon>article</mat-icon>
87+
</button>
88+
<button mat-icon-button>
89+
<mat-icon>call</mat-icon>
90+
</button>
91+
</fs-ui-frame-toolbar-center>
92+
93+
<fs-ui-frame-toolbar-side>
94+
<mat-form-field appearance="outline">
95+
<input matInput placeholder="Search" type="search" />
96+
</mat-form-field>
97+
</fs-ui-frame-toolbar-side>
98+
</fs-ui-frame-toolbar>
99+
100+
<fs-ui-frame-content>
101+
<router-outlet></router-outlet>
102+
</fs-ui-frame-content>
103+
</fs-ui-frame>
104+
```
105+
106+
</TabItem>
107+
108+
<TabItem value="ts" label="TS">
109+
110+
```typescript
111+
import { Component, OnInit } from "@angular/core";
112+
import { FormBuilder, FormControl, Validators } from "@angular/forms";
113+
import {
114+
FrameConfig,
115+
FrameEvent,
116+
FrameEvents,
117+
NavUser,
118+
} from "@ite/ng-daimlertruck";
119+
import { routes } from "./app-routing.module";
120+
121+
@Component({
122+
selector: "example",
123+
templateUrl: "example.html",
124+
styleUrls: ["example.css"],
125+
})
126+
export class ExampleComponent implements OnInit {
127+
title = "FS DevOps`s ng mat components";
128+
appRoutes = routes;
129+
130+
frameConfig: FrameConfig = {
131+
appName: "Dummy App",
132+
// appNameShort: stringOfLength('DUMMY', 0, 6),
133+
logo: "https://upload.wikimedia.org/wikipedia/commons/thumb/c/cf/Angular_full_color_logo.svg/1024px-Angular_full_color_logo.svg.png",
134+
};
135+
navUser: NavUser = {
136+
profilePicture:
137+
"https://material.angular.io/assets/img/examples/shiba1.jpg",
138+
name: "Some User",
139+
role: "Engineer",
140+
};
141+
142+
ngOnInit() {}
143+
144+
onEvent(frameEvent: FrameEvent) {
145+
switch (frameEvent.type) {
146+
case FrameEvents.MANAGE_ACCOUNT:
147+
console.log("Manage Account called, do something...");
148+
break;
149+
case FrameEvents.LOGOUT:
150+
console.log("Logout called, do something...");
151+
break;
152+
default:
153+
console.error(`unknown event fetched: ${JSON.stringify(event)}`);
154+
break;
155+
}
156+
}
157+
}
158+
```
159+
160+
</TabItem>
161+
<TabItem value="scss" label="SCSS">
162+
163+
```css
164+
165+
```
166+
167+
</TabItem>
168+
</Tabs>

‎docs/02-ng-mat-components/02-fs-nav-frame-module/_category_.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
label: 'fs nav frame Module'
2+
collapsible: true
3+
collapsed: true
4+
link:
5+
type: generated-index

‎docs/02-ng-mat-components/03-fs-calendar-module/API-panels.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
```typescript
2+
import { FsCalendarModule } from "@fullstack-devops/ng-mat-components";
3+
```
4+
5+
## References
6+
7+
- demo: https://fullstack-devops.github.io/ng-mat-components/calendar-panels
8+
- code example:
9+
[app.component.html](https://github.com/fullstack-devops/ng-mat-components/blob/main/projects/lib-workspace/src/app/app.component.html)
10+
[app.component.ts](https://github.com/fullstack-devops/ng-mat-components/blob/main/projects/lib-workspace/src/app/app.component.ts)
11+
12+
---
13+
14+
## Directives
15+
16+
```bash
17+
.
18+
└── fs-calendar-panels
19+
```
20+
21+
---
22+
23+
## Examples
24+
25+
### minimal
26+
27+
=== "HTML"
28+
29+
```html
30+
<div style="height: 80%">
31+
<fs-calendar-panels
32+
[placeholderDay]="placeholder"
33+
[dataSource]="dataSource"
34+
[year]="todayYear"
35+
[month]="todayMonth"
36+
[monthsBefore]="monthsBefore"
37+
[monthsAfter]="monthsAfter"
38+
(selection)="testMethod($event)"
39+
>
40+
</fs-calendar-panels>
41+
</div>
42+
```
43+
44+
=== "TS"
45+
46+
``` typescript
47+
// ...
48+
import {
49+
CalendarEvent,
50+
CalendarPanels,
51+
} from "@fullstack-devops/ng-mat-components";
52+
53+
@Component({
54+
selector: "example",
55+
templateUrl: "example.html",
56+
styleUrls: ["example.css"],
57+
})
58+
export class ExampleComponent implements OnInit {
59+
// this cannot be empty
60+
dataSource: CalendarPanels = {
61+
config: {
62+
renderMode: "monthly", // 'annual' | 'monthly'
63+
selectMode: "range", // 'click' | 'range'
64+
displayYear: true,
65+
firstDayOfWeekMonday: true,
66+
calendarWeek: true,
67+
switches: true,
68+
panelWidth: "300px",
69+
bluredDays: false, // default: false
70+
markWeekend: true, // default: true
71+
},
72+
data: [],
73+
};
74+
75+
constructor() {}
76+
77+
ngOnInit() {}
78+
79+
testMethod(event: CalendarEvent) {
80+
switch (event.type) {
81+
case "range":
82+
this.range = event;
83+
break;
84+
case "click":
85+
this.range = event;
86+
break;
87+
}
88+
console.log(event);
89+
}
90+
}
91+
```
92+
93+
=== "CSS"
94+
95+
``` css
96+
97+
```

‎docs/02-ng-mat-components/03-fs-calendar-module/API-table.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
```typescript
2+
import { FsCalendarModule } from "@fullstack-devops/ng-mat-components";
3+
```
4+
5+
## References
6+
7+
- demo: https://fullstack-devops.github.io/ng-mat-components/calendar-table
8+
- code example: https://github.com/fullstack-devops/ng-mat-components/tree/main/projects/lib-workspace/src/app/content/calendar-table
9+
10+
---
11+
12+
## Directives
13+
14+
```bash
15+
.
16+
└── fs-calendar-table
17+
└── fs-calendar-table-name
18+
```
19+
20+
---
21+
22+
## Examples
23+
24+
### ui-frame in form
25+
26+
=== "HTML"
27+
28+
```html
29+
<section class="mat-elevation-z4">
30+
<fs-calendar-table [dataSource]="calTableData">
31+
<fs-calendar-table-name> Persons </fs-calendar-table-name>
32+
</fs-calendar-table>
33+
</section>
34+
```
35+
36+
=== "TS"
37+
38+
``` typescript
39+
// ...
40+
import { CalendarTableEntry } from "@fullstack-devops/ng-mat-components";
41+
42+
@Component({
43+
selector: "example",
44+
templateUrl: "example.html",
45+
styleUrls: ["example.css"],
46+
})
47+
export class ExampleComponent implements OnInit {
48+
// this can also be empty
49+
calTableData: CalendarTableEntry[] = [
50+
{
51+
name: "Test User",
52+
data: [
53+
{
54+
date: new Date(this.today.getFullYear(), this.today.getMonth(), 20),
55+
toolTip: "Some longer text",
56+
char: "",
57+
colors: {
58+
backgroundColor: "#FFFFFF",
59+
color: "#000",
60+
},
61+
},
62+
],
63+
},
64+
];
65+
66+
constructor() {}
67+
68+
ngOnInit() {}
69+
}
70+
```
71+
72+
=== "CSS"
73+
74+
``` css
75+
76+
```

‎docs/02-ng-mat-components/03-fs-calendar-module/_category_.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
label: 'fs calendar Module'
2+
collapsible: true
3+
collapsed: true
4+
link:
5+
type: generated-index

‎docs/02-ng-mat-components/_category_.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
label: "Library NG Mat Components"
2+
collapsible: true
3+
collapsed: true
4+
# className: red
5+
link:
6+
type: generated-index
7+
title: Library NG Mat Components

‎docs/03-awesome-ci

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/03-awesome-ci/01-overview.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: Overview
3+
---
4+
5+
# Welcome to the Awesome CI!
6+
7+
This project is the smart connection between your pipeline for continuous integration and your version management like GitLab or GitHub. The focus is on the release process, followed by the version management of SemVer. The required version number is created with the correct naming of the branch prefix.
8+
9+
You can use this tool in your CI pipeline or locally on your command line. Just download the most recently released version and get started. You can find out how to integrate this into your respective pipeline in the following document. There are also several examples in the examples section of the documentation. If an example is not included, please feel free to inquire about a related issue.
10+
11+
If more functionality is needed you can just open a problem in this project and of course bugs can be fixed in the same way by filing a bug report.
12+
13+
If you have any questions, you can find a form on the issue board. First, make sure your question is already in the Questions and Answers section before asking a question. You can find frequently asked questions directly in the "Questions and Answers" section.
14+
15+
:::info
16+
17+
Every command that you can use is in the sidebar at cli. All options are listed there or use the `awesome-ci help` command.
18+
19+
:::
20+
:::tip
21+
22+
If you need an example for your pipeline you can find it in the sidebar under the tab examples.
23+
24+
:::
25+
26+
### Supported naming rules and effects on the version
27+
28+
The patching of the version only takes effect if the merged branch begins with the following aliases, for example: `feature/my-awesome-feature`
29+
30+
:::caution
31+
The tailing `/` behind the alias is **always** requiered!
32+
:::
33+
34+
| SemVer | supported aliases | version example |
35+
| ------ | -------------------------------------- | --------------- |
36+
| MAJOR | `major` | 1.2.3 => 2.0.0 |
37+
| MINOR | `minor`, `feature`, `feat` | 1.2.3 => 1.3.0 |
38+
| PATCH | `patch`, `fix`, `bugfix`, `dependabot` | 1.2.3 => 1.2.4 |
39+
40+
:::info
41+
see also [override specialties](#override-specialties)
42+
:::
43+
44+
![awesome-ci release process](/img-awesome-ci/release-process.drawio.svg "awesome-ci release process")
45+
![awesome-ci workflow](/img-awesome-ci/aci-workflow.drawio.png "awesome-ci workflow")
46+
47+
:::tip
48+
Awesoce CI automatically detects your environment. Supported are **Jenkins**, **GitHub Actions** and ~~GitLab CI~~
49+
:::
50+
51+
### Override specialties
52+
53+
To set some attributes during developement you can comment a pullrequest.
54+
55+
### Requiered and optional environment variables
56+
57+
List of all environmental variables used per CES (code execution service).
58+
59+
#### GitHub Actions
60+
61+
| Environment variable | Description | Status | Requiered |
62+
| -------------------- | -------------------------------------------------- | ------------- | :-------: |
63+
| `CI` | Is set by GitHub actions and returns `true` | set by runner | true |
64+
| `GITHUB_SERVER_URL` | The GitHub-Server URL. | set by runner | true |
65+
| `GITHUB_REPOSITORY` | The owner and repository name. | set by runner | true |
66+
| `GITHUB_TOKEN` | Must provided in workflow as `env:` (see examples) | set by runner | true |
67+
68+
#### GitLab Workflows
69+
70+
| Environment variable | Description | Status | requiered |
71+
| -------------------- | -------------------------------------------------------------- | ------------- | :-------: |
72+
| `CI` | Is set by GitLab Workflows and returns `true` | set by runner | true |
73+
| `CI_SERVER_URL` | Will only be set by using the GitHub Plugin. | set by runner | true |
74+
| `CI_PROJECT_URL` | The owner and repository name. | set by runner | true |
75+
| `CI_JOB_TOKEN` | Must provided in pipeline as `env.GITHUB_TOKEN` (see examples) | set by runner | true |
76+
77+
#### Jenkins Pipeline
78+
79+
| Environment variable | Description | Status | requiered |
80+
| -------------------- | -------------------------------------------------------------- | ---------------------------- | :-------: |
81+
| `CI` | Is set by Jenkins Pipeline and returns `true` | set by jenkins | true |
82+
| `JENKINS_URL` | Returns the URL of your Jenkins instance. (Already set) | set by jenkins | true |
83+
| `GIT_URL` | Will only be set by using the GitHub Plugin. | set by jenkins plugin github | true |
84+
| `GITHUB_REPOSITORY` | The owner and repository name. | must be set manually | true |
85+
| `GITHUB_TOKEN` | Must provided in pipeline as `env.GITHUB_TOKEN` (see examples) | must be set manually | true |
86+
87+
:::tip
88+
To see your Jenkins environment variables go to: `${YOUR_JENKINS_HOST}/env-vars.html`
89+
:::

‎docs/03-awesome-ci/02-cli/_category_.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
label: 'CLI'
2+
collapsible: true
3+
collapsed: true
4+
link:
5+
type: generated-index

‎docs/03-awesome-ci/02-cli/awesome-ci.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "awesome-ci"
3+
---
4+
## awesome-ci
5+
6+
Awesome CI make your release tagging easy
7+
8+
### Synopsis
9+
10+
Awesome CI make your release tagging easy
11+
Comatible with CI pipelines like Jenkins and GitHub
12+
Find more information and examples at: https://github.com/fullstack-devops/awesome-ci
13+
14+
```
15+
awesome-ci [flags]
16+
```
17+
18+
### Options
19+
20+
```
21+
-h, --help help for awesome-ci
22+
-v, --verbose verbose output
23+
```
24+
25+
### SEE ALSO
26+
27+
* [awesome-ci connect](./awesome-ci_connect) - connect persistent to github by creating an encrypted rc file
28+
* [awesome-ci parse](./awesome-ci_parse) - parse json and yaml files and inspect values like jq
29+
* [awesome-ci pr](./awesome-ci_pr) - pull request
30+
* [awesome-ci release](./awesome-ci_release) - release
31+
* [awesome-ci version](./awesome-ci_version) - Print the version number of Awesome-CI
32+
33+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_connect.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "_ connect"
3+
---
4+
## awesome-ci connect
5+
6+
connect persistent to github by creating an encrypted rc file
7+
8+
### Synopsis
9+
10+
connect initial to a GitHub or GitHub Enterprise
11+
at some point you can also connect to GitLab (not yet implemented)
12+
this is only useful without a runner or in an jenkins pipeline
13+
14+
```
15+
awesome-ci connect [flags]
16+
```
17+
18+
### Options
19+
20+
```
21+
-h, --help help for connect
22+
```
23+
24+
### Options inherited from parent commands
25+
26+
```
27+
-v, --verbose verbose output
28+
```
29+
30+
### SEE ALSO
31+
32+
* [awesome-ci](./awesome-ci) - Awesome CI make your release tagging easy
33+
* [awesome-ci connect check](./awesome-ci_connect_check) - check current connection
34+
* [awesome-ci connect github](./awesome-ci_connect_github) - connect initial to a GitHub or GitHub Enterprise
35+
* [awesome-ci connect remove](./awesome-ci_connect_remove) - remove all connection files and secrets
36+
37+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_connect_check.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "_ connect check"
3+
---
4+
## awesome-ci connect check
5+
6+
check current connection
7+
8+
```
9+
awesome-ci connect check [flags]
10+
```
11+
12+
### Options
13+
14+
```
15+
-h, --help help for check
16+
```
17+
18+
### Options inherited from parent commands
19+
20+
```
21+
-v, --verbose verbose output
22+
```
23+
24+
### SEE ALSO
25+
26+
* [awesome-ci connect](./awesome-ci_connect) - connect persistent to github by creating an encrypted rc file
27+
28+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_connect_github.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "_ connect github"
3+
---
4+
## awesome-ci connect github
5+
6+
connect initial to a GitHub or GitHub Enterprise
7+
8+
```
9+
awesome-ci connect github [flags]
10+
```
11+
12+
### Options
13+
14+
```
15+
-h, --help help for github
16+
-r, --repository string (required) repo eg.: octo-org/octo-repo
17+
-s, --server string (required) github instance to connect (default "https://github.com")
18+
-t, --token string (required) plain token eg.: ghp_*****
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```
24+
-v, --verbose verbose output
25+
```
26+
27+
### SEE ALSO
28+
29+
* [awesome-ci connect](./awesome-ci_connect) - connect persistent to github by creating an encrypted rc file
30+
31+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_connect_remove.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "_ connect remove"
3+
---
4+
## awesome-ci connect remove
5+
6+
remove all connection files and secrets
7+
8+
```
9+
awesome-ci connect remove [flags]
10+
```
11+
12+
### Options
13+
14+
```
15+
-h, --help help for remove
16+
```
17+
18+
### Options inherited from parent commands
19+
20+
```
21+
-v, --verbose verbose output
22+
```
23+
24+
### SEE ALSO
25+
26+
* [awesome-ci connect](./awesome-ci_connect) - connect persistent to github by creating an encrypted rc file
27+
28+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_parse.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "_ parse"
3+
---
4+
## awesome-ci parse
5+
6+
parse json and yaml files and inspect values like jq
7+
8+
### Synopsis
9+
10+
parse json and yaml files and inspect values like jq
11+
12+
```
13+
awesome-ci parse [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-f, --file string file to be parsed
20+
-h, --help help for parse
21+
-q, --query string (required) query for output
22+
-s, --string string query for output
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
-v, --verbose verbose output
29+
```
30+
31+
### SEE ALSO
32+
33+
* [awesome-ci](./awesome-ci) - Awesome CI make your release tagging easy
34+
* [awesome-ci parse json](./awesome-ci_parse_json) - parse a json string or file
35+
* [awesome-ci parse yaml](./awesome-ci_parse_yaml) - parse a yaml string or file
36+
37+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_parse_json.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "_ parse json"
3+
---
4+
## awesome-ci parse json
5+
6+
parse a json string or file
7+
8+
```
9+
awesome-ci parse json [flags]
10+
```
11+
12+
### Options
13+
14+
```
15+
-h, --help help for json
16+
```
17+
18+
### Options inherited from parent commands
19+
20+
```
21+
-f, --file string file to be parsed
22+
-q, --query string (required) query for output
23+
-s, --string string query for output
24+
-v, --verbose verbose output
25+
```
26+
27+
### SEE ALSO
28+
29+
* [awesome-ci parse](./awesome-ci_parse) - parse json and yaml files and inspect values like jq
30+
31+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_parse_yaml.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "_ parse yaml"
3+
---
4+
## awesome-ci parse yaml
5+
6+
parse a yaml string or file
7+
8+
```
9+
awesome-ci parse yaml [flags]
10+
```
11+
12+
### Options
13+
14+
```
15+
-h, --help help for yaml
16+
```
17+
18+
### Options inherited from parent commands
19+
20+
```
21+
-f, --file string file to be parsed
22+
-q, --query string (required) query for output
23+
-s, --string string query for output
24+
-v, --verbose verbose output
25+
```
26+
27+
### SEE ALSO
28+
29+
* [awesome-ci parse](./awesome-ci_parse) - parse json and yaml files and inspect values like jq
30+
31+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_pr.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: "_ pr"
3+
---
4+
## awesome-ci pr
5+
6+
pull request
7+
8+
### Synopsis
9+
10+
All software has versions. This is Awesome-CI's
11+
12+
```
13+
awesome-ci pr [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-h, --help help for pr
20+
```
21+
22+
### Options inherited from parent commands
23+
24+
```
25+
-v, --verbose verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
* [awesome-ci](./awesome-ci) - Awesome CI make your release tagging easy
31+
* [awesome-ci pr info](./awesome-ci_pr_info) - get pull request info
32+
33+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_pr_info.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: "_ pr info"
3+
---
4+
## awesome-ci pr info
5+
6+
get pull request info
7+
8+
### Synopsis
9+
10+
Print all infos about a pull request in GitHub.
11+
12+
```
13+
awesome-ci pr info [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-h, --help help for info
20+
-c, --merge-commit-sha string send a given merge commit sha
21+
-n, --number int overwrite the issue number
22+
```
23+
24+
### Options inherited from parent commands
25+
26+
```
27+
-v, --verbose verbose output
28+
```
29+
30+
### SEE ALSO
31+
32+
* [awesome-ci pr](./awesome-ci_pr) - pull request
33+
34+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_release.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "_ release"
3+
---
4+
## awesome-ci release
5+
6+
release
7+
8+
### Synopsis
9+
10+
tbd
11+
12+
```
13+
awesome-ci release [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-b, --body string custom release message (markdown string or file)
20+
--dry-run make dry-run before writing version to Git by calling it
21+
-h, --help help for release
22+
--hotfix create a hotfix release
23+
--merge-sha string set the merge sha
24+
-l, --patch-level string predefine patch level of version to Update
25+
--prnumber int overwrite the issue number
26+
--release-branch string set release branch (default: git default)
27+
--release-prefix string set a custom release prefix (default -> Release or Hotfix)
28+
--version string override version to Update
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
-v, --verbose verbose output
35+
```
36+
37+
### SEE ALSO
38+
39+
* [awesome-ci](./awesome-ci) - Awesome CI make your release tagging easy
40+
* [awesome-ci release create](./awesome-ci_release_create) - create a GitHub release
41+
* [awesome-ci release publish](./awesome-ci_release_publish) - publish a GitHub release
42+
43+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_release_create.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: "_ release create"
3+
---
4+
## awesome-ci release create
5+
6+
create a GitHub release
7+
8+
### Synopsis
9+
10+
Print all infos about a pull request in GitHub.
11+
12+
```
13+
awesome-ci release create [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-h, --help help for create
20+
```
21+
22+
### Options inherited from parent commands
23+
24+
```
25+
-b, --body string custom release message (markdown string or file)
26+
--dry-run make dry-run before writing version to Git by calling it
27+
--hotfix create a hotfix release
28+
--merge-sha string set the merge sha
29+
-l, --patch-level string predefine patch level of version to Update
30+
--prnumber int overwrite the issue number
31+
--release-branch string set release branch (default: git default)
32+
--release-prefix string set a custom release prefix (default -> Release or Hotfix)
33+
-v, --verbose verbose output
34+
--version string override version to Update
35+
```
36+
37+
### SEE ALSO
38+
39+
* [awesome-ci release](./awesome-ci_release) - release
40+
41+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_release_publish.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "_ release publish"
3+
---
4+
## awesome-ci release publish
5+
6+
publish a GitHub release
7+
8+
### Synopsis
9+
10+
Print all infos about a pull request in GitHub.
11+
12+
```
13+
awesome-ci release publish [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-a, --asset stringArray define output by get
20+
-h, --help help for publish
21+
--release-id int publish an early defined release (also looking for env ACI_RELEASE_ID)
22+
```
23+
24+
### Options inherited from parent commands
25+
26+
```
27+
-b, --body string custom release message (markdown string or file)
28+
--dry-run make dry-run before writing version to Git by calling it
29+
--hotfix create a hotfix release
30+
--merge-sha string set the merge sha
31+
-l, --patch-level string predefine patch level of version to Update
32+
--prnumber int overwrite the issue number
33+
--release-branch string set release branch (default: git default)
34+
--release-prefix string set a custom release prefix (default -> Release or Hotfix)
35+
-v, --verbose verbose output
36+
--version string override version to Update
37+
```
38+
39+
### SEE ALSO
40+
41+
* [awesome-ci release](./awesome-ci_release) - release
42+
43+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/02-cli/awesome-ci_version.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "_ version"
3+
---
4+
## awesome-ci version
5+
6+
Print the version number of Awesome-CI
7+
8+
### Synopsis
9+
10+
All software has versions. This is Awesome-CI's
11+
12+
```
13+
awesome-ci version [flags]
14+
```
15+
16+
### Options
17+
18+
```
19+
-h, --help help for version
20+
```
21+
22+
### Options inherited from parent commands
23+
24+
```
25+
-v, --verbose verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
* [awesome-ci](./awesome-ci) - Awesome CI make your release tagging easy
31+
32+
###### Auto generated by spf13/cobra on 25-Feb-2023

‎docs/03-awesome-ci/03-examples/_category_.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
label: 'Examples'
2+
collapsible: true
3+
collapsed: true
4+
link:
5+
type: generated-index

‎docs/03-awesome-ci/03-examples/github-actions.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: GitHub Actions
3+
---
4+
5+
# GitHub Actions examples
6+
7+
### Build a Release
8+
9+
This is an example from th awesome-ci project you can find the original workflow [here](https://github.com/fullstack-devops/awesome-ci/blob/main/.github/workflows/Release.yaml).
10+
11+
```yaml title="release.yaml"
12+
name: Publish Release
13+
14+
on:
15+
push:
16+
branches:
17+
- "main"
18+
19+
jobs:
20+
create_release:
21+
runs-on: ubuntu-latest
22+
outputs:
23+
release-id: ${{ steps.tag.outputs.ACI_RELEASE_ID }}
24+
version: ${{ steps.tag.outputs.ACI_NEXT_VERSION }}
25+
steps:
26+
- name: Check out the repo
27+
uses: actions/checkout@v3
28+
- name: Setup awesome-ci
29+
uses: fullstack-devops/awesome-ci-action@main
30+
31+
- name: create release
32+
id: tag
33+
run: awesome-ci release create --merge-sha ${{ github.sha }}
34+
env:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
36+
37+
build:
38+
runs-on: ubuntu-latest
39+
needs: create_release
40+
strategy:
41+
matrix:
42+
arch: ["amd64", "arm64"]
43+
steps:
44+
- name: Checkout code
45+
uses: actions/checkout@v3
46+
- name: Set up Go
47+
uses: actions/setup-go@v3
48+
with:
49+
go-version: 1.19
50+
51+
- name: Build "${{ matrix.arch }}"
52+
run: make VERSION="${{ needs.create_release.outputs.version }}"
53+
env:
54+
GOOS: linux
55+
GOARCH: "${{ matrix.arch }}"
56+
57+
- name: Cache build outputs
58+
uses: actions/cache@v3
59+
env:
60+
cache-name: cache-outputs-modules
61+
with:
62+
path: out/
63+
key: awesome-ci-${{ github.sha }}-${{ hashFiles('out/awesome-ci*') }}
64+
restore-keys: |
65+
awesome-ci-${{ github.sha }}
66+
67+
publish_release:
68+
runs-on: ubuntu-latest
69+
needs: [create_release, build]
70+
steps:
71+
- name: Checkout code
72+
uses: actions/checkout@v3
73+
- name: Setup awesome-ci
74+
uses: fullstack-devops/awesome-ci-action@main
75+
76+
- name: get cached build outputs
77+
uses: actions/cache@v3
78+
env:
79+
cache-name: cache-outputs-modules
80+
with:
81+
path: out/
82+
key: awesome-ci-${{ github.sha }}
83+
84+
- name: Publish Release
85+
run: awesome-ci release publish --release-id "$ACI_RELEASE_ID" --asset "file=out/$ARTIFACT1" --asset "file=out/$ARTIFACT2"
86+
env:
87+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
88+
ACI_RELEASE_ID: ${{ needs.create_release.outputs.release-id }}
89+
ARTIFACT1: awesome-ci_${{ needs.create_release.outputs.version }}_amd64
90+
ARTIFACT2: awesome-ci_${{ needs.create_release.outputs.version }}_arm64
91+
```
92+
93+
You need more examples? Please open an issue!

‎docs/03-awesome-ci/03-examples/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Examples
3+
---
4+
5+
# Examples
6+
7+
All available examples are shown here.
8+
If you need support with a pipeline not shown here, you are welcome to open an issue.
9+
10+
The examples for Jenkins and Gitlab Ci are coming soon!

‎docs/03-awesome-ci/04-qaa.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Questions and Answers
3+
---
4+
5+
# Questions and Answers
6+
7+
Frequently asked questions are shown here.
8+
9+
...

‎docs/03-awesome-ci/05-contributing.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: CONTRIBUTING
3+
---
4+
5+
# Contributing
6+
7+
When contributing to this repository, please first discuss the change you wish to make via issue,
8+
email, or any other method with the owners of this repository before making a change.
9+
10+
Please note we have a code of conduct, please follow it in all your interactions with the project.
11+
12+
## Pull Request Process
13+
14+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
15+
build.
16+
2. Update the README.md with details of changes to the interface, this includes new environment
17+
variables, exposed ports, useful file locations and container parameters.
18+
3. Make sure your branch starts with our semantic versioning aliase eg.: `bugfix/`, `feature/`.
19+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
20+
do not have permission to do that, you may request the second reviewer to merge it for you.
21+
22+
## Naming software internal
23+
24+
| Name | Description |
25+
| ------------ | -------------------------------------- |
26+
| `ces` | code execution service |
27+
| `scm-portal` | means GitHub, GitLab or Bitbucket etc. |
28+
29+
### Abstraction of layers
30+
31+
![Abstraction of layers](/img-awesome-ci/layers.svg)
32+
33+
## Code of Conduct
34+
35+
### Our Pledge
36+
37+
In the interest of fostering an open and welcoming environment, we as
38+
contributors and maintainers pledge to making participation in our project and
39+
our community a harassment-free experience for everyone, regardless of age, body
40+
size, disability, ethnicity, gender identity and expression, level of experience,
41+
nationality, personal appearance, race, religion, or sexual identity and
42+
orientation.
43+
44+
### Our Standards
45+
46+
Examples of behavior that contributes to creating a positive environment
47+
include:
48+
49+
- Using welcoming and inclusive language
50+
- Being respectful of differing viewpoints and experiences
51+
- Gracefully accepting constructive criticism
52+
- Focusing on what is best for the community
53+
- Showing empathy towards other community members
54+
55+
Examples of unacceptable behavior by participants include:
56+
57+
- The use of sexualized language or imagery and unwelcome sexual attention or
58+
advances
59+
- Trolling, insulting/derogatory comments, and personal or political attacks
60+
- Public or private harassment
61+
- Publishing others' private information, such as a physical or electronic
62+
address, without explicit permission
63+
- Other conduct which could reasonably be considered inappropriate in a
64+
professional setting
65+
66+
### Our Responsibilities
67+
68+
Project maintainers are responsible for clarifying the standards of acceptable
69+
behavior and are expected to take appropriate and fair corrective action in
70+
response to any instances of unacceptable behavior.
71+
72+
Project maintainers have the right and responsibility to remove, edit, or
73+
reject comments, commits, code, wiki edits, issues, and other contributions
74+
that are not aligned to this Code of Conduct, or to ban temporarily or
75+
permanently any contributor for other behaviors that they deem inappropriate,
76+
threatening, offensive, or harmful.
77+
78+
### Scope
79+
80+
This Code of Conduct applies both within project spaces and in public spaces
81+
when an individual is representing the project or its community. Examples of
82+
representing a project or community include using an official project e-mail
83+
address, posting via an official social media account, or acting as an appointed
84+
representative at an online or offline event. Representation of a project may be
85+
further defined and clarified by project maintainers.
86+
87+
### Enforcement
88+
89+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
90+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
91+
complaints will be reviewed and investigated and will result in a response that
92+
is deemed necessary and appropriate to the circumstances. The project team is
93+
obligated to maintain confidentiality with regard to the reporter of an incident.
94+
Further details of specific enforcement policies may be posted separately.
95+
96+
Project maintainers who do not follow or enforce the Code of Conduct in good
97+
faith may face temporary or permanent repercussions as determined by other
98+
members of the project's leadership.
99+
100+
### Attribution
101+
102+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
103+
available at [http://contributor-covenant.org/version/1/4][version]
104+
105+
[homepage]: http://contributor-covenant.org
106+
[version]: http://contributor-covenant.org/version/1/4/

‎docs/03-awesome-ci/_category_.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
label: "Awesome CI"
2+
collapsible: true
3+
collapsed: true
4+
link:
5+
type: generated-index
6+
title: Awesome CI

‎package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"serve": "docusaurus serve",
1313
"write-translations": "docusaurus write-translations",
1414
"write-heading-ids": "docusaurus write-heading-ids",
15+
"sync-modules-docs": "ts-node syncModulesDocs.ts",
1516
"typecheck": "tsc"
1617
},
1718
"dependencies": {
@@ -29,6 +30,8 @@
2930
"devDependencies": {
3031
"@docusaurus/module-type-aliases": "2.3.1",
3132
"@tsconfig/docusaurus": "^1.0.5",
33+
"sync-directory": "^6.0.2",
34+
"ts-node": "^10.9.1",
3235
"typescript": "^4.7.4"
3336
},
3437
"browserslist": {

‎syncModulesDocs.ts

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
const syncDirecotry = require("sync-directory");
2+
3+
interface SyncElement {
4+
module: string;
5+
targetDir: string;
6+
}
7+
const elementsToBeSynced: SyncElement[] = [
8+
{
9+
module: "ng-mat-components",
10+
targetDir: "02-ng-mat-components",
11+
},
12+
{
13+
module: "awesome-ci",
14+
targetDir: "03-awesome-ci",
15+
},
16+
];
17+
18+
elementsToBeSynced.forEach((element) => {
19+
let modulePath = `modules/${element.module}/docs/docs`
20+
let targetPath = `docs/${element.targetDir}`
21+
22+
console.log(`syncing ${modulePath} to ${targetPath}`)
23+
24+
syncDirecotry(modulePath, targetPath, {
25+
deleteOrphaned: true,
26+
});
27+
});

‎yarn.lock

Lines changed: 181 additions & 4 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)
Please sign in to comment.