Skip to content

Commit d61479a

Browse files
committed
add some notes
1 parent c09ba5a commit d61479a

File tree

1 file changed

+41
-15
lines changed

1 file changed

+41
-15
lines changed

content/_index.md

+41-15
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ The architecture of each bounded context follows the Clean Architecture's struct
9797
<img class="stretch no-border" src="img/clean-architecture.svg" alt="clean architecture">
9898

9999
{{% note %}}
100+
100101
- INVERS DELLE DIP e ISOLAM DOM
101102
- types: concetti dominio mappati 1a1(vedremo come) indipendenti, pochi cambiamenti
102103
- azioni: accedere/usare info dominio (es. creaz pp, prezzat ordine)
@@ -163,30 +164,37 @@ gitGraph
163164
merge fix/fix-2 tag: "1.0.1"
164165
{{< /mermaid >}}
165166

167+
{{% note %}}
168+
169+
- `beta` branch nelle prime fase di sviluppo: pre-release
170+
- `main` branch: release stabili
171+
- Branch protection: feature via PRs
172+
- Ogni feature o fix ha un suo branch e mergiato via PR
173+
- Workflow favorito da tools usati (slide successive)
174+
- **Assenza branch develop**
175+
176+
{{% /note %}}
177+
166178
---
167179

168-
## Conventional Commit
180+
## Conventional Commits
169181

170-
To enforce `conventional commit` we developed
182+
To enforce `Conventional Commits` we developed
171183
a [_gradle plugin_](https://github.com/nicolasfara/conventional-commits) and an
172184
[_sbt plugin_](https://github.com/nicolasfara/sbt-conventional-commits).
173185
The plugin is handy since:
174186

175-
- It creates a git hook as soon as the project is imported
176-
(one cannot forget to set it up!)
177-
- It can also be configured through ad-hoc plug-in keys
187+
- It creates a git hook as soon as the project is imported (you don't forget to set it up!)
188+
- It can also be configured through plug-in keys
178189

179190
{{% note %}}
180191

181192
Perché usare `conventional commit`?
182193

183-
- Determinare automaticamente il version bump
184-
- Avviare build e publishing del progetto in automatico
185-
- Generare automaticamenet CHANGELOGs
186194
- Storia dei commit più facile da capire
187-
188-
- Husky e commitlint non ci piacevano perché uno se ne può dimenticare
189-
dato che richiedono intervento manuale
195+
- Strumenti lo usano per effettuare version bump automatico
196+
- Generare automaticamente CHANGELOGs
197+
- Limitazioni `Husky` e `commitlint` in progetti non js
190198

191199
{{% /note %}}
192200

@@ -197,11 +205,11 @@ Perché usare `conventional commit`?
197205
[`semantic-release`](https://semantic-release.gitbook.io/semantic-release/)
198206
automates the whole package release workflow:
199207

200-
- Determines the next version number
208+
- Determines automatically the next version number
201209
- Generates the release notes
202-
- Publishes the package
210+
- Publishes the artifacts ([`Maven Central`](https://search.maven.org/search?q=g:dev.atedeg.mdm) and [`Docker Hub`](https://hub.docker.com/search?q=atedeg) in our case)
203211

204-
The use of __Conventional Commits__ combined with __Semantic Release__ helped us to automate the release process
212+
The use of **Conventional Commits** combined with **Semantic Release** helped us to automate the release process
205213

206214
---
207215

@@ -222,7 +230,7 @@ Each of these tools is used in CI to prevent the merging of bad code
222230
The following workflow is the result of a pipeline optimization that seeks to take full advantage of the parallelism between jobs:
223231

224232
{{< mermaid >}}
225-
%%{init: {'theme':'base'}}%%
233+
%%{init: {'theme':'base', 'themeVariables': { 'fontFamily': 'Inter' }}}%%
226234
flowchart LR
227235
SFMT(Scalafmt) --> B
228236
SFX(Scalafix) --> B
@@ -235,6 +243,14 @@ flowchart LR
235243

236244
To simplify the `Publish` job, the [`scala-release`](https://github.com/atedeg/scala-release) action was developed
237245

246+
{{% note %}}
247+
248+
- Usate `GitHub Actions` per CI/CD
249+
- Ottimizzazione dei workflow: parallelismo
250+
- `scala-release` action: semplifica il processo di pubblicazione
251+
252+
{{% /note %}}
253+
238254
---
239255

240256
## Project Management
@@ -243,6 +259,14 @@ To simplify the `Publish` job, the [`scala-release`](https://github.com/atedeg/s
243259
- All backlog items are tracked by linked GitHub issues
244260
- Closing PRs and issues automatically advances the project status
245261

262+
{{% note %}}
263+
264+
- Utilizzo di Github projects per gestione progetto
265+
- Traccia dei backlog items attraverso issue
266+
- Chiusura PR automaticamente chiude issue aggiornando stato progetto
267+
268+
{{% /note %}}
269+
246270
{{% /section %}}
247271

248272
---
@@ -402,6 +426,7 @@ We needed a way to automatically generate documentation pages containing the
402426
ubiquitous language definitions coming from the scaladoc
403427

404428
{{% note %}}
429+
405430
- tutti i concetti sono mappati 1:1
406431
- evitare inconsistenze tra codice e documentazione (copia incolla)
407432
- così esperto di dominio e programmatori sono allineati
@@ -446,6 +471,7 @@ _"...except as required for reasonable and customary use_
446471
_in describing the origin of the Work..."_
447472

448473
{{% note %}}
474+
449475
- in una situa reale progetto chiuso perché potrebbe segreti industriali
450476
- MARCHIO REGISTRATO
451477
{{% /note %}}

0 commit comments

Comments
 (0)