Github messages for voidlinux
 help / color / mirror / Atom feed
From: sgn <sgn@users.noreply.github.com>
To: ml@inbox.vuxu.org
Subject: [PR PATCH] lint commits's message
Date: Mon, 17 May 2021 17:22:53 +0200	[thread overview]
Message-ID: <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-30950@inbox.vuxu.org> (raw)

[-- Attachment #1: Type: text/plain, Size: 1581 bytes --]

There is a new pull request by sgn against master on the void-packages repository

https://github.com/sgn/void-packages lint-commits
https://github.com/void-linux/void-packages/pull/30950

lint commits's message
<!-- Mark items with [x] where applicable -->

#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)

#### Have the results of the proposed changes been tested?
- [ ] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [ ] I generally don't use the affected packages but briefly tested this PR

<!--
If GitHub CI cannot be used to validate the build result (for example, if the
build is likely to take several hours), make sure to
[skip CI](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration).
When skipping CI, uncomment and fill out the following section.
Note: for builds that are likely to complete in less than 2 hours, it is not
acceptable to skip CI.
-->
<!-- 
#### Does it build and run successfully? 
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [ ] I built this PR locally for my native architecture, (ARCH-LIBC)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
  - [ ] aarch64-musl
  - [ ] armv7l
  - [ ] armv6l-musl
-->


A patch file from https://github.com/void-linux/void-packages/pull/30950.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-lint-commits-30950.patch --]
[-- Type: text/x-diff, Size: 3370 bytes --]

From 4d8d3c52fd286e8770f9a6a88ac72a0621d519c2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C4=90o=C3=A0n=20Tr=E1=BA=A7n=20C=C3=B4ng=20Danh?=
 <congdanhqx@gmail.com>
Date: Mon, 17 May 2021 22:10:52 +0700
Subject: [PATCH 1/2] shutils: add basic commit lint

Warn if:
* subject is longer than 50 characters
Error if:
* any lines are longer than 80 characters
* second line is not blank
---
 common/xbps-src/shutils/lint_commits.sh | 39 +++++++++++++++++++++++++
 xbps-src                                |  8 +++++
 2 files changed, 47 insertions(+)
 create mode 100755 common/xbps-src/shutils/lint_commits.sh

diff --git a/common/xbps-src/shutils/lint_commits.sh b/common/xbps-src/shutils/lint_commits.sh
new file mode 100755
index 000000000000..9e5ec3a57ffd
--- /dev/null
+++ b/common/xbps-src/shutils/lint_commits.sh
@@ -0,0 +1,39 @@
+#!/bin/bash
+
+lint_commits() {
+	local base="$1"
+	local status=0
+	local cmt
+	if [ -n "$base" ]; then
+		base=$("$XBPS_GIT_CMD" rev-parse --verify "$base") ||
+			return
+	elif base=$("$XBPS_GIT_CMD" rev-parse --verify FETCH_HEAD 2>/dev/null); then
+		:
+	elif base=$("$XBPS_GIT_CMD" rev-parse --verify ORIG_HEAD 2>/dev/null); then
+		:
+	else
+		echo base commit not found >&2
+		exit 1
+	fi
+
+	for cmt in $("$XBPS_GIT_CMD" rev-list --reverse --abbrev-commit "$base"..HEAD)
+	do
+		"$XBPS_GIT_CMD" cat-file commit "$cmt" |
+		awk -vC="$cmt" '
+		/^$/ && !msg { msg = 1; next }
+		!msg { next }
+		!/ / && (length > 80) { print C ": long line: " $0; exit 1 }
+		!subject {
+			if (length > 50) { print C ": subject is a bit long" }
+			# Below check is too noisy?
+			# if (!($0 ~ "^New package:" || $0 ~ ".*: update to")) {
+			#	print C ": not new package/update/removal?"
+			# }
+			subject = 1; next
+		}
+		/^$/ { body = 1; next }
+		!body { print C ": second line must be blank"; exit 1 }
+		' || status=1
+	done
+	return $status
+}
diff --git a/xbps-src b/xbps-src
index c3cd7e5db10b..c5dbac6a90b3 100755
--- a/xbps-src
+++ b/xbps-src
@@ -141,6 +141,10 @@ update-hash-cache
 zap
     Removes a masterdir but preserving ccache, distcc and host directories.
 
+lint-commits [base-commit]
+    Do basic check on commit made from [base-commit] exclusively.
+    If [base-commit] omited, FETCH_HEAD or ORIG_HEAD will be used.
+
 Options:
 
 -1  If dependencies of target package are missing, fail instead of building them.
@@ -964,6 +968,10 @@ case "$XBPS_TARGET" in
     zap)
         masterdir_zap
         ;;
+    lint-commits)
+        shift
+        lint_commits "$@"
+        ;;
     *)
         msg_red "xbps-src: invalid target $XBPS_TARGET.\n"
         usage && exit 1

From 5e6931f4303c2c40e28ab2839876c217c496858b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C4=90o=C3=A0n=20Tr=E1=BA=A7n=20C=C3=B4ng=20Danh?=
 <congdanhqx@gmail.com>
Date: Mon, 17 May 2021 22:21:09 +0700
Subject: [PATCH 2/2] workflows: enable lint-commits

---
 .github/workflows/build.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 1ea1da2e4881..2da230588b1c 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -21,6 +21,7 @@ jobs:
       - run: common/travis/changed_templates.sh
       - run: common/travis/fetch-xtools.sh
       - run: common/travis/xlint.sh
+      - run: ./xbps-src lint-commits FETCH_HEAD
 
   # Build changed packages.
   build:

             reply	other threads:[~2021-05-17 15:22 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-17 15:22 sgn [this message]
2021-05-17 15:27 ` [PR PATCH] [Updated] " sgn
2021-05-17 15:28 ` [PR REVIEW] " ericonr
2021-05-17 15:28 ` ericonr
2021-05-17 15:28 ` ericonr
2021-05-17 15:29 ` ericonr
2021-05-17 15:32 ` [PR PATCH] [Updated] " sgn
2021-05-17 15:33 ` [PR REVIEW] " sgn
2021-05-17 15:37 ` sgn
2021-05-17 15:37 ` sgn
2021-05-17 15:42 ` [PR PATCH] [Updated] " sgn
2021-05-17 16:31 ` Duncaen
2021-05-18  5:23 ` sgn
2021-05-18 16:11 ` [PR PATCH] [Updated] " sgn
2021-05-18 16:12 ` [PR REVIEW] " sgn
2021-05-18 16:12 ` sgn
2021-05-19  0:44 ` [PR PATCH] [Updated] " sgn
2021-05-19  0:56 ` sgn
2021-05-19 16:15 ` [PR REVIEW] " paper42
2021-05-20  0:48 ` sgn
2021-05-20  0:50 ` [PR PATCH] [Updated] " sgn
2021-05-20 16:33 ` sgn
2021-05-21  8:56 ` [PR PATCH] [Merged]: " sgn

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-30950@inbox.vuxu.org \
    --to=sgn@users.noreply.github.com \
    --cc=ml@inbox.vuxu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).