Merge pull request #765 from lorenzwalthert/enforce-news-update-on-push

- Enforce news update on push (#765).

Author: lorenzwalthert

.Rbuildignore

@@ -21,3 +21,5 @@ revdep
 ^touchstone$
 ^\.github$
 ^LICENSE\.md$
+^inst/hooks/$
+^inst/WORDLIST$

.pre-commit-config.yaml

@@ -1,5 +1,7 @@
 # All available hooks: https://pre-commit.com/hooks.html
 # R specific hooks: https://github.com/lorenzwalthert/precommit
+default_stages: [commit]
+
 repos:
 -   repo: https://github.com/lorenzwalthert/precommit
     rev: v0.1.2.9001
@@ -56,3 +58,10 @@ repos:
         language: fail
         files: '\.Rhistory|\.RData|\.Rds|\.rds$'
         # `exclude: <regex>` to allow committing specific files.
+    -   id: require-news-on-push
+        name: Require bullet in NEWS.md
+        description: NEWS.md must be updated with every PR.
+        entry: inst/hooks/require-news-update.R
+        stages: [push]
+        language: script
+        files: ""

NEWS.md

@@ -1,8 +1,9 @@
 # styler 1.4.0.9000 (Development)
 
 * Hexadecimal integers now preserve the trailing `L` when styled (#761).
-
 * Add more examples to `styler_*` helpfiles (#762).
+* Add a pre-push hook to make sure news bullets are added to each PR (#765).
+
 # styler 1.4.0
 
 ## API Changes

inst/WORDLIST

@@ -73,6 +73,7 @@ github
 gitsum
 GSOC
 hashFiles
+helpfiles
 href
 http
 https

inst/hooks/require-news-update.R

@@ -0,0 +1,10 @@
+#! /usr/local/bin/Rscript
+args <- system2(
+  "git",
+  c("diff", "upstream/master", "--name-only"),
+  stdout = TRUE
+)
+
+if (!any(args == "NEWS.md")) {
+  rlang::abort("Must have a news entry before pushing.")
+}