JuliaDocs/Documenter.jl

CI job to push automated fixes to PRs

Offen

#2.229 geöffnet am 22.08.2023

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Type: Maintenancegood first issuehelp wanted

Repository-Metriken

Stars
 (910 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

We could have a CI workflow that could fix some semi-automated chores you sometimes need to do for PRs. Ideally it would only run when explicitly asked, e.g. when a PR label is set? It could do the following things:

  • Update link references in CHANGELOG.md
  • Rebuild the theme CSS files.
  • Push code formatter fixes (we only have prettier right now, but at some point we might also have JuliaFormatter)

As a proof of concept, this prettier actions does that for prettier formatting checks: https://github.com/creyD/prettier_action

This would be a good first issue for anyone who wants to learn how to write slightly non-trivial GitHub Actions workflows.

Contributor Guide

Research-Richtung
Überprüfen Sie die aktuellen GitHub Actions Workflows im Repository, verstehen Sie, wie sie ausgelöst werden, und entwerfen Sie einen neuen Workflow, der bei einem Label Ereignis ausgeführt wird, um die genannten Aufgaben (CHANGELOG aktualisieren, CSS neu erstellen, prettier ausführen) zu automatisieren. Sehen Sie sich das in der Issue verlinkte Beispiel an, um Inspiration zu erhalten.
Tech Stack
github actions
Domain
ci cd
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitCI/CDGitHub Actions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75