(BSR) docs(ci): add details on version's bumps #6754
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pierrecanthelou
requested review from
tanguyprache and
bruno-ebstein-pass-culture
Performance Comparison ReportSignificant Changes To Render DurationThere are no entries Meaningless Changes To Render DurationShow entries
Show details
Changes To Render CountThere are no entries Added ScenariosThere are no entries Removed ScenariosThere are no entries |
|
all over the file version's number to reflect that
|
bruno-ebstein-pass-culture
requested changes
Aug 12, 2024
Comment on lines
+11
to
+14
| - environment variable changed or added | ||
| - new native library | ||
| - new build step | ||
| - ... |
There was a problem hiding this comment.
avant me semblait plus proche de ce qu'on veut
je ne comprends pas
Comment on lines
+21
to
+29
| <p>SemVer (Semantic Versioning) is a standardized versioning system used to label software versions in a clear and predictable way. It follows the format MAJOR.MINOR.PATCH (e.g., 1.4.2), where:</p> | ||
| <ul> | ||
| <li><strong>MAJOR</strong> (<mark>X</mark>.y.z): Incremented when there are <mark>incompatible changes</mark> or breaking changes. Example: 2.0.0 -> 3.0.0</li> | ||
| <li><strong>MINOR</strong> (x.<mark>Y</mark>.z): Incremented when <mark>new features</mark> are added that are backward compatible. Example: 2.1.0 -> 2.2.0</li> | ||
| <li><strong>PATCH</strong> (x.y.<mark>Z</mark>): Incremented for <mark>bug fixes or minor changes</mark> that don't affect the API.Example: 2.1.1 -> 2.1.2</li> | ||
| <li><strong>BUILD or REVISION</strong> (x.y.z.<mark>W</mark>): Incremented with <mark>every build or release iteration</mark>, often used internally to distinguish between minor changes or bug fixes within the same patch version.</li> | ||
| </ul> | ||
| <p><strong>Example</strong><br/> | ||
| A version update from 1.4.2 to 1.5.0 introduces new features without breaking existing functionality, while an update from 1.4.2 to 2.0.0 introduces incompatible changes.</p> |
There was a problem hiding this comment.
pourquoi mettre du HTML dans un fichier markdown pour des choses faisables en markdown ?
la doc est déjà longue (et donc lue en diagonale) est-ce nécessaire d'ajouter une définition commune accessible ailleurs ?
| @@ -28,7 +43,7 @@ Then the build is faster as only the javascript code is published. The download | |||
| #### Troubleshooting | |||
|
|
|||
| <details> | |||
| <summary>I don't see my changes on testing</summary> | |||
| <summary>I don't see my changes on testing</summary> | |||
There was a problem hiding this comment.
les indentations HTML avec un seul espace, c'est peu commun, généralement, c'est 2, 4 ou tab
| @@ -103,31 +118,64 @@ If not urgent (but still can't wait until the next MEP), it's better for the use | |||
|
|
|||
| ### How | |||
|
|
|||
| - List all tags of the version `X.X.X`, tags of type: `vX.X.X-Y` (`git fetch --tag`and then `git tag | grep vX.X`) | |||
| - List all tags of the version `X.Y.Z`, tags of type: `vX.Y.Z-W` (`git fetch --tag`and then `git tag | grep vX.Y`) | |||
There was a problem hiding this comment.
W est juste avant dans l'alphabet, et pourrait laisser penser que c'est le plus gros increment, alors qu'il se trouve à la fin
en maths, K et N sont souvent utilisé pour désigner des nombres sans importances
détails, non bloquant : je recommande K ou N à la place de W
|
|
||
| - Set Tag under version « 301 » | ||
| - Testing is under version number 302, compilation and merges on master prepare the 302's future version well | ||
| - Staging is compiled from tag's 301, we are testing version 301 |
There was a problem hiding this comment.
pour éviter les confusions
Suggested change
| - Staging is compiled from tag's 301, we are testing version 301 | |
| - Staging is compiled from tag's 301, we are checking version 301 |
ou
Suggested change
| - Staging is compiled from tag's 301, we are testing version 301 | |
| - Staging is compiled from tag's 301, we are reviewing version 301 |
ou
Suggested change
| - Staging is compiled from tag's 301, we are testing version 301 | |
| - Staging is compiled from tag's 301, we are validating by the QA version 301 |
| - Prod is compiled from tag's 302, we publish result of 301+302 | ||
| - New iteration goes on 303 | ||
|
|
||
| Nous lançons la mes de la version 303 (MeS). |
There was a problem hiding this comment.
the rest of le document is en anglais
why ici is en french ?
| - Staging is under version number 300 | ||
| - Prod is under version number 300 | ||
|
|
||
| We run processes for 301 (MeS). |
There was a problem hiding this comment.
je ne suis pas certain de comprendre ce qui est sous entendu par "We run processes"
|
|
||
| Check if you can find it on AppCenter. Example for [staging iOS][8]. | ||
|
|
||
|  | ||
|
|
||
| </details> | ||
|
|
||
| ## Sprints, MeS and MeP |
There was a problem hiding this comment.
j'ai l'impression que cette section essaie de représenter ce qui se passe au fil du temps
je trouverais ça bien plus simple à comprendre avec quelque chose de visuel
je recommande un graph Mermaid, peut etre https://mermaid.js.org/syntax/timeline.html ou https://mermaid.js.org/syntax/gitgraph.html ou alors celui avec lequel on peut faire plein de trucs https://mermaid.js.org/syntax/flowchart.html
| Nous lançons la mes de la version 303 (MeS). | ||
|
|
||
| - Set Tag under version « 303 » | ||
| - Testing is under version number 304, le compilation et les merges sur master préparent bien la future version 304 |
There was a problem hiding this comment.
français or english but nous devrions be plus consistent
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Juste pour que tout le monde puisse bien comprendre les variations de numéros de versions quand on passe différentes itérations.
NB : J'ai remplacé les doubles espaces par un simple espace lors d'une commande groupée...