Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.7 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.7 KB
Raw

stale-md

CircleCI

Find stale documentation through CI.

stale-md is a CircleCI orb that identifies stale documentation (ie 90 days of unchanged .md file) and warns developers on maintaining their documentation.

Usage

version: 2.1

orbs:
  stale-md: mkotsollaris/[email protected]
  orb-tools: circleci/[email protected]

jobs:
  scan:
    docker:
      - image: cimg/base:current
    steps:
      - checkout
      - stale-md/scan

workflows:
  main:
    jobs:
      - scan

Options

parameters:
  IGNORED_FILES:
    type: string
    default: "./.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST.md"
    description: "files to be ignored (space-separated)"
  DAYS_THRESHOLD:
    type: string
    default: "90"
    description: "Time threshold in days"

Example here.

Motivation

Inspired by Software Engineering at Google, where there was a reference that Google runs a similar pattern internally to embrace continuous software engineering developments and constantly update their documentation.

By utilizing this orb command, developers are reminded that while their software updates so does their documentation. This orb aims to treat documentation as a first-class citizen, similar to production level code where documentation is always remaining up to date.

Resources

License

MIT