spotify/scio

GHA should run `sbt mdoc` on pull requests that update `site` directory

Open

#4,214 opened on Jan 18, 2022

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)Scala (529 forks)auto 404
buildgood first issue

Repository metrics

Stars
 (2,626 stars)
PR merge metrics
 (PR metrics pending)

Description

we should validate updates to the site by running sbt mdoc on relevant PRs

Contributor guide

Research direction
Add a GitHub Actions workflow that triggers on PRs modifying the site directory and runs `sbt mdoc` to validate documentation changes.
Tech stack
scala
Domain
devopsdocumentation
Issue type
DevOps
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitScalasbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60