JuliaDocs/Documenter.jl

CI job to push automated fixes to PRs

Open

#2,229 建立於 2023年8月22日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Julia (910 star) (513 fork)batch import
Type: Maintenancegood first issuehelp wanted

描述

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.

貢獻者指南

技術棧
github actionsshelljavascriptcss
領域
ci cddevopstooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
GitHub ActionsYAMLprettier
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65
研究方向
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.