JuliaDocs/Documenter.jl

CI job to push automated fixes to PRs

Aberta

#2.229 aberto em 22 de ago. de 2023

Ver no GitHub
 (6 comentários) (0 reação) (0 responsável)Julia (513 forks)batch import
Type: Maintenancegood first issuehelp wanted

Métricas do repositório

Stars
 (910 estrelas)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Revise os fluxos de trabalho atuais do GitHub Actions no repositório, entenda como eles são acionados e projete um novo fluxo que seja executado em um evento de rótulo para automatizar as tarefas mencionadas (atualizar CHANGELOG, reconstruir CSS, executar prettier). Veja a ação de exemplo vinculada na issue para inspiração.
Pilha de tecnologia
github actions
Domain
ci cd
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitCI/CDGitHub Actions
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75