changer le mode de calcul du badge

deronnax commented 4 years ago

Je pense que le badge "progress" est une excellente incitation au traduction. Actuellement, le calcul du progrès est fait sur tout le dépot, ce qui fait que la progression progresse très peu, à cause de c-api et whatsnew. Je vais sous peu (Julien est d'accord) changer le mode de calcul pour exclure distutils, c-api et whatsnew, et faire une github action pour mettre le badge à jour à chaque merge significatif (~ +30 de lignes). Le badge sera porté par shield.io. Chaque contribution un peu significative fera de manière visible augmenter le pourcentage de progression.

deronnax commented 4 years ago

@vpoulailleau si tu as des pistes à donner pour commencer sur la Github Action, je prends.

vpoulailleau commented 4 years ago

@deronnax

Il faut un fichier /.github/workflows/progress_badge.yml à la racine du dépôt, du style :

name: Update progress badge

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
    - uses: actions/checkout@v2

    - name: run custom script
      run: $GITHUB_WORKSPACE/chemin_qui_va_bien_depuis_la_racine/update_badge.sh

    - name: Push changes
      uses: ad-m/github-push-action@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}

Il faut ensuite créer /chemin_qui_va_bien_depuis/update_badge.sh qui a pour objectif de faire un commit git si nécessaire :

# ta tambouille de modification du README
# - tu calcules le nouveau progress
# - si il est (assez ?) différent du progress précédent, tu modifies le README

# puis un truc du style

# commit modification if any
git config --local user.email "vpoulailleau@gmail.com"
git config --local user.name "vpoulailleau"
git commit -a -m "update progress badge" lebonchemin/README.md || true

À noter que dans le .yaml tu peux faire un script bash, mais un script Python est aussi une possibilité.

JulienPalard commented 1 year ago

On a migré le repo sur https://git.afpy.org/AFPy/python-docs-fr, si quelqu'un veut travailler sur ç, qu'il ouvre une issue de l'autre côté.

python / python-docs-fr

changer le mode de calcul du badge #1291