Make less commits in CI

[deemp]

Current solution

Currently, CI always commits updated atoms (link) and Markdown files (link).

Benefits

• Devs can see almost immediately what parts of docs and what atoms have changed.
• Diffs are shown using GitHub's functionality.
• Updates can be overwritten by force pushes (assuming that usually, only one person works on a PR).

Downsides

• A work-in-progress PR could have several pushes before being ready, each of which may (incorrectly) update the docs and flood with redundant commits.
• If git is not configured properly locally, it is possible to end up with several merge commits (due to not pulling before committing again).

Suggestion

• Add a comment when diff is non-empty (link).
• Actually update the documentation only
  • on master
  • on workflow_dispatch

Benefits

• Does not add unsolicited commits to an active PR.
• Notifies the developer that some output in the docs has changed to review it (perhaps it was unintentional).

Downsides

• Does not review the changes to the docs as part of the PR (it is possible to implement this, but would introduce some technical complexity).

Similar workflow

(link)

• detects if this PR is for a new release
• adds a comment saying so and a label
• the label is detected by another workflow (https://github.com/illright/attractions/blob/main/.github/workflows/auto-release.yml)
• that workflow makes the release