Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add yaml header check #184

Merged
merged 28 commits into from
May 28, 2024
Merged

Add yaml header check #184

merged 28 commits into from
May 28, 2024

Conversation

gounux
Copy link
Contributor

@gounux gounux commented Mar 17, 2024 •
edited
Loading

👀 #178

  • le nom de/s auteur/ices correspond/ent ils à un fichier team/{{trigramme}}.md
  • la date est-elle bien dans le futur
  • vérifier que le ratio de l'image, si elle est définie, soit conforme
  • vérifier que la/les catégorie/s soient parmi celles listées
  • vérifier que les tags sont dans l'ordre alphabétique
  • vérifier que les clés obligatoires sont bien présentes

@gounux gounux changed the title Add yaml header check wip Add yaml header check Mar 17, 2024
@github-actions github-actions bot added enhancement New feature or request quality labels Mar 17, 2024
@gounux
Copy link
Contributor Author

gounux commented Apr 17, 2024

cc @Guts

L'idéal serait que la commande sorte un texte en markdown et qu'on soit en mesure de la faire tourner dans la CI. Mais bon sur ce point, il faudrait d'abord résoudre l'ambiguité sur quel contenu est à publier et donc à checker.

En l'état la commande prend en paramètre un fichier et vérifie quelques trucs par rapport à l'entête. On part sur vérifier tous les contenus dans la CI ? Compliqué alors de gérer les dates ?

À noter qu'il y a déjà des amorces dans le code avec python-frontmatter mais que c'est éparse ou à refaire. D'ailleurs, il serait peut-être plus intéressant de lire les fichiers Markdown avec Mkdocs pour utiliser le même outil.

Actuellement il n'y a pas d'outils externes utilisés, si tu as des idées je suis preneur

@gounux gounux requested a review from Guts April 17, 2024 18:31
@gounux gounux marked this pull request as ready for review April 17, 2024 18:32
@Guts Guts force-pushed the feature/add-markdown-header-checker branch from 1f46e9e to 274e435 Compare April 25, 2024 19:37
@gounux gounux mentioned this pull request Apr 26, 2024
Merged
@Guts Guts assigned Guts and gounux May 2, 2024
@gounux gounux requested a review from Guts May 23, 2024 09:17
Guts
Guts requested changes May 27, 2024
View reviewed changes
Copy link
Member

@Guts Guts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Le package tiers unicode est overkill pour le besoin et on a déjà un gros paquet de dépendances à trainer :/.

Le check de vérification de l'ordre alphabétique des tags semble ne pas fonctionner :

geotribu check ../website/content/articles/2024/2024-03-18_crowdscourcing_avec_cocarto.md 
2024-05-27 18:31:31||ERROR||header_check||run||218||Les tags ne sont pas triés par ordre alphabétique : ['cocarto', 'contribution', 'collecte', 'collecte terrain', 'smartphone']

Allez zou, après ça, on merge, on package et on teste en conditions réelles

geotribu_cli/content/header_check.py Outdated Show resolved Hide resolved
geotribu_cli/content/header_check.py Outdated Show resolved Hide resolved
Guts
Guts requested changes May 27, 2024
View reviewed changes
Copy link
Member

@Guts Guts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quelques suggestions pour utiliser pathlib pour être plus cohérent avec le reste de la base de code

geotribu_cli/content/header_check.py Outdated Show resolved Hide resolved
geotribu_cli/content/header_check.py Outdated Show resolved Hide resolved
geotribu_cli/content/header_check.py Outdated Show resolved Hide resolved
@gounux
Copy link
Contributor Author

gounux commented May 27, 2024

Le check de vérification de l'ordre alphabétique des tags semble ne pas fonctionner :

geotribu check ../website/content/articles/2024/2024-03-18_crowdscourcing_avec_cocarto.md 
2024-05-27 18:31:31||ERROR||header_check||run||218||Les tags ne sont pas triés par ordre alphabétique : ['cocarto', 'contribution', 'collecte', 'collecte terrain', 'smartphone']

En même temps ça ne me semble pas trié par ordre alphabétique..

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented May 28, 2024

Quality Gate Passed Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@gounux gounux merged commit c540843 into main May 28, 2024
31 checks passed
@gounux gounux deleted the feature/add-markdown-header-checker branch May 28, 2024 09:48
@Guts Guts linked an issue Jun 23, 2024 that may be closed by this pull request
Aide à l'édition : vérificateur de l'en-tête des fichiers markdown #178
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Guts Guts Guts approved these changes

Assignees

@Guts Guts

@gounux gounux

Labels
dependencies enhancement New feature or request quality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Aide à l'édition : vérificateur de l'en-tête des fichiers markdown
2 participants
@gounux @Guts