JuliaDocs/Documenter.jl

CI job to push automated fixes to PRs

Open

#2.229 geöffnet am 22. Aug. 2023

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

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

Tech Stack
github actionsshelljavascriptcss
Domain
ci cddevopstooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
GitHub ActionsYAMLprettier
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
Look at the existing GitHub Actions workflows in the repository (e.g., .github/workflows/) to understand the CI setup. The issue suggests using the creyD/prettier action for prettier formatting. Research that action and adapt it to also include link reference updates in CHANGELOG.md and rebuilding theme CSS files. The workflow should be triggered by a specific PR label. Check if there are any existing label based triggers in the repo. Since there are no comments, the scope is well defined, but you may need to ask about the exact label to use.