JuliaDocs/Documenter.jl

CI job to push automated fixes to PRs

Open

#2,229 opened on Aug 22, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (910 stars) (513 forks)batch import
Type: Maintenancegood first issuehelp wanted

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GitHub ActionsYAMLprettier
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.