Skip to content

Commit

Permalink
more transition to using *development* as the um... development branch.
Browse files Browse the repository at this point in the history
  • Loading branch information
petersilva committed Oct 24, 2023
1 parent 76464c0 commit c4caba6
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 21 deletions.
17 changes: 9 additions & 8 deletions docs/source/Contribution/Development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,9 @@ and all development is co-ordinated through issues exactly as v2 is. Issues uniq
they regressions or enhancements that don't make sense to add to v2, have the tag *v3only*.
Issues that are common between the releases are tagged *v3*.

The workflow with v3 is similar to v2 but with different branches. New development work should
have a v03\_ prefix, such as v03\_issue401. Having all the flow tests complete fairly successfully
The workflow with v3 is similar to v2 but with different branches. branches are assumed
to be branched from the *development* branch, so v3 is assumed unless v2\_ is present.
Having all the flow tests complete fairly successfully
is one criterion for acceptance into development.

To run the sr_insects tests, the repository must be cloned with the development branch.
Expand Down Expand Up @@ -1169,8 +1170,8 @@ FIXME: steps missing, more clarity required.

Most components will use MQTT instead of amqp and can be run normally.

Commits to the Main Branch
--------------------------
Commits to the Development Branch
---------------------------------

Aside from typos, language fixups in the documentation, and incrementing
the version, developers are not expected to commit to main. All work
Expand All @@ -1182,7 +1183,7 @@ request on github.

::
git checkout issueXXX # v03_issueXXX for v3 work.
git checkout issueXXX # v02_issueXXX for v2 work., github suggested branch names are fine also.
vi CHANGES.rst # summarize the changes in Restructured Text
dch # copy/paste from CHANGES.rst, inserting one leading space.
vi doc/UPGRADING.rst # rarely, if code has user impact.
Expand Down Expand Up @@ -1215,15 +1216,15 @@ The current set up is that there are four main branches:
the development branch is used to build sr3 packages for the `Daily <https://launchpad.net/~ssc-hpc-chp-spc/+archive/ubuntu/metpx-daily>`_
and `Pre-Release <https://launchpad.net/~ssc-hpc-chp-spc/+archive/ubuntu/metpx-pre-release>`_ repositories on launchpad.net.

* issue branches to be merged to development, it should be called v3_issueXXX
* issue branches to be merged to development, it should be start with issueXXX or suggested branch names from github are ok also.

* sometimes, multiple branches are needed for a single issue, say for variations of a fix, eg. issueXXX_2_do_it_this_way .

* v2_dev ... the integration branch for v2 maintenance used prior to promotion to v2_stable.

* v2_stable ... generally this branch gets code via merges from v2_dev, after the pre-release has been tested on a
as many systems as possible. used to build packages on the stable: `MetPX <https://launchpad.net/~ssc-hpc-chp-spc/+archive/ubuntu/metpx>`_

* issue branches to be merged to main should be called issueXXX.


Repositories
------------
Expand Down
25 changes: 12 additions & 13 deletions docs/source/fr/Contribution/Développement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Les éléments qui seront installés par configuration automatisée :
après avoir cloné le code source::

git clone -b development https://github.com/MetPX/sarracenia sr3
git clone -b v03 https://github.com/MetPX/sarrac sr3c
git clone -b development https://github.com/MetPX/sarrac metpx-sr3c
git clone https://github.com/MetPX/sr_insects insects
cd sr3

Expand Down Expand Up @@ -106,9 +106,9 @@ et tout le développement est coordonné par des issues exactement comme l’est
sont les régressions ou améliorations qui n’ont pas de sens à ajouter à v2, ont la balise *v3only*.
Les problèmes communs entre les versions sont marqués *v3*.

Le flux de travail avec v3 est similaire à v2 mais avec des branches différentes. De nouveaux travaux de
développement devraient avoir un préfixe v03\_, tel que v03_issue401. Avoir tous les tests de flux
complétés avec assez de succès est l’un des critères d’acceptation dans development.
Le flux de travail avec v3 est similaire à v2 mais avec des branches différentes.
Avoir tous les tests de flux
complétés avec assez de succès est un des critères d’acceptation dans development.

Pour exécuter les tests sr_insects, le référentiel doit être cloné avec la branche development.
Une porte pour la fusion à development est pour un deuxième développeur d’exécuter le flow_tests.
Expand Down Expand Up @@ -1211,14 +1211,13 @@ demande sur GitHub.

::
git checkout issueXXX # v03_issueXXX for v3 work.
vi CHANGES.rst # summarize the changes in Restructured Text
dch # copy/paste from CHANGES.rst, inserting one leading space.
vi doc/UPGRADING.rst # rarely, if code has user impact.
git checkout issueXXX # v02_issueXXX pour du travaille sur l´ancienne version.
dch # résumer les changement dans changelog.
vi doc/UPGRADING.rst # rarement en cas de changement visible dont l´usager doit prendre connaissance.
vi doc/fr/UPGRADING.rst # bon... ceci est visible aux usagers, donc...
git commit -a
git push
# issue a pull request on github.com.
# déclencher un *pull request* chez github.com

Un deuxième développeur examinera la demande d’extraction et le réviseur décidera si
la fusion est appropriée. On s’attend à ce que le développeur examine chaque validation, et
Expand Down Expand Up @@ -1491,15 +1490,15 @@ prend la source à partir d’une branche différente : *v03_launchpad*. Pour ch
doit être rebasée à partir de *development*

* git checkout v03_launchpad
* git rebase development
* git rebase -i development
* git push
* import souce
* import source
* Request build from *metpx-sr3-daily-bionic* Recipe.

En quoi cette branche *v03_launchpad* est-elle différente ? Elle:

* Supprime la dépendance sur python3-paho-mqtt car la version dans les référentiels est trop ancienne.
* Suppression de la dépendance sur python3-dateparser, car ce paquet n’est pas disponible dans le référentiel.
* Supprime la dépendance sur python3-paho-mqtt car la version dans le *repository* d´ubuntu est trop ancienne.
* Suppression de la dépendance sur python3-dateparser, car ce paquet n’est pas disponible dans le *repository* d´ubuntu.
* remplacer la cible de test dans debian/rules, parce que tester sans les dépendances échoue ::

override_dh_auto_test:
Expand Down

0 comments on commit c4caba6

Please sign in to comment.