[bug#74051] [PATCH] gnu: Add emacs-weblorg

[bug#74051] [PATCH] gnu: Add emacs-weblorg

[Mattia Bunel]

Change-Id: Iae2d6cbbadec7a171e1e5b8502d4f47701d7af5b
---
 gnu/packages/emacs-xyz.scm | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 488b4cb5d7..0ff7ac08ca 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -38230,6 +38230,26 @@ (define-public emacs-org-static-blog
 a @samp{date} keywords, and optionally, a @samp{filetags} keyword.")
     (license license:bsd-3)))
 
+(define-public emacs-weblorg
+  (package
+    (name "emacs-weblorg")
+    (version "0.1.2")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (string-append "https://stable.melpa.org/packages/" "weblorg-"
+                           version ".tar"))
+       (sha256
+        (base32 "0lvjfhysiyaz8klbj01da5jdjw1p4vvd9kl1zmi9vciazayh82ch"))))
+    (build-system emacs-build-system)
+    (propagated-inputs (list emacs-templatel))
+    (home-page "https://emacs.love/weblorg")
+    (synopsis "Static site generator for org-mode")
+    (description
+     "@code{emacs-weblorg} is a static site generator for org-mode,
+based on @code{templatel} library.")
+    (license license:gpl3+)))
+
 (define-public emacs-ddskk
   (let ((commit "8c47f46e38a29a0f3eabcd524268d20573102467")
         (revision "0"))

base-commit: 091131af64fd4e4e925fff829fa19097cfcdfcc5
-- 
2.47.0

[bug#74051] [PATCH] gnu: Add emacs-weblorg

[Nicolas Goaziou via Guix-patches via]

Hello,

Mattia Bunel <mattia.bunel@ehess.fr> writes:

> Change-Id: Iae2d6cbbadec7a171e1e5b8502d4f47701d7af5b

Thank you for your patch. There are some (small) things to fix before it
can be merged, tho.

First you need to write a proper commit message, such as:

  gnu: Add emacs-weblorg.

  * gnu/packages/emacs-xyz.scm (emacs-weblorg): New variable.

> +(define-public emacs-weblorg
> +  (package
> +    (name "emacs-weblorg")
> +    (version "0.1.2")

The version is not actually "0.1.2", or rather, it seems we need to pick
a commit after this tag. You should let-bind the commit hash, i.e.,
"0db218bd6b2e083546d3a69a022dfb1a08900acd", to a `commit' symbol.
Then, `version' field would become:

  (version (git-version "0.1.2" revision commit))

See, e.g., `emacs-taskrunner' package definition.

> +    (source
> +     (origin
> +       (method url-fetch)
> +       (uri (string-append "https://stable.melpa.org/packages/" "weblorg-"
> +                           version ".tar"))

Upstream is on GitHub, not on Stable MELPA. The package should use
`git-fetch' method, and

  (uri (git-reference
        (url "https://github.com/emacs-love/weblorg")
        (commit commit)))

as the `uri' field.

Also, you need to add

  (file-name (git-file-name name version))

before the `sha256' field.

> +       (sha256
> +        (base32 "0lvjfhysiyaz8klbj01da5jdjw1p4vvd9kl1zmi9vciazayh82ch"))))
> +    (build-system emacs-build-system)

There are tests. You may want to run them, probably with

  (arguments
   (list #:tests? #t
         #:test-command '("emacs" "--batch"
                          "-l" "t/weblorg-tests.el"
                          "-f" "ert-run-tests-batch-and-exit")))

There seem to be some documentation in the "doc/" directory. What should
be done about it?

> +    (propagated-inputs (list emacs-templatel))
> +    (home-page "https://emacs.love/weblorg")
> +    (synopsis "Static site generator for org-mode")

Nitpick: org-mode -> Org mode

> +    (description
> +     "@code{emacs-weblorg} is a static site generator for org-mode,
> +based on @code{templatel} library.")

Nitpick: @code{emacs-weblorg} -> Weblorg, org-mode -> Org mode. I also
suggest to remove the reference about Templatel library in the
description.

Could you send an updated patch? If you have any trouble doing so,
please let us know.

Regards,
-- 
Nicolas Goaziou

[bug#74051] [PATCH] gnu: Add emacs-weblorg

[Mattia Bunel]

Hello Nicolas,

Thanks for your review.

I've written a new patch based on your comments. What is the correct 
procedure for sending it? Should I send a patch based on *origin/master* 
or the previous patch you reviewed?

For documentation, the weblorg *doc/* folder contains the sources for 
the project website. My opinion is therefore not to include them.

Regards,

Le 28/10/2024 à 00:18, Nicolas Goaziou a écrit :
> Hello,
> 
> Mattia Bunel <mattia.bunel@ehess.fr> writes:
> 
>> Change-Id: Iae2d6cbbadec7a171e1e5b8502d4f47701d7af5b
> 
> Thank you for your patch. There are some (small) things to fix before it
> can be merged, tho.
> 
> First you need to write a proper commit message, such as:
> 
>    gnu: Add emacs-weblorg.
> 
>    * gnu/packages/emacs-xyz.scm (emacs-weblorg): New variable.
> 
>> +(define-public emacs-weblorg
>> +  (package
>> +    (name "emacs-weblorg")
>> +    (version "0.1.2")
> 
> The version is not actually "0.1.2", or rather, it seems we need to pick
> a commit after this tag. You should let-bind the commit hash, i.e.,
> "0db218bd6b2e083546d3a69a022dfb1a08900acd", to a `commit' symbol.
> Then, `version' field would become:
> 
>    (version (git-version "0.1.2" revision commit))
> 
> See, e.g., `emacs-taskrunner' package definition.
> 
>> +    (source
>> +     (origin
>> +       (method url-fetch)
>> +       (uri (string-append "https://stable.melpa.org/packages/" "weblorg-"
>> +                           version ".tar"))
> 
> Upstream is on GitHub, not on Stable MELPA. The package should use
> `git-fetch' method, and
> 
>    (uri (git-reference
>          (url "https://github.com/emacs-love/weblorg")
>          (commit commit)))
> 
> as the `uri' field.
> 
> Also, you need to add
> 
>    (file-name (git-file-name name version))
> 
> before the `sha256' field.
> 
>> +       (sha256
>> +        (base32 "0lvjfhysiyaz8klbj01da5jdjw1p4vvd9kl1zmi9vciazayh82ch"))))
>> +    (build-system emacs-build-system)
> 
> There are tests. You may want to run them, probably with
> 
>    (arguments
>     (list #:tests? #t
>           #:test-command '("emacs" "--batch"
>                            "-l" "t/weblorg-tests.el"
>                            "-f" "ert-run-tests-batch-and-exit")))
> 
> There seem to be some documentation in the "doc/" directory. What should
> be done about it?
> 
>> +    (propagated-inputs (list emacs-templatel))
>> +    (home-page "https://emacs.love/weblorg")
>> +    (synopsis "Static site generator for org-mode")
> 
> Nitpick: org-mode -> Org mode
> 
>> +    (description
>> +     "@code{emacs-weblorg} is a static site generator for org-mode,
>> +based on @code{templatel} library.")
> 
> Nitpick: @code{emacs-weblorg} -> Weblorg, org-mode -> Org mode. I also
> suggest to remove the reference about Templatel library in the
> description.
> 
> Could you send an updated patch? If you have any trouble doing so,
> please let us know.
> 
> Regards,

[bug#74051] [PATCH] gnu: Add emacs-weblorg

[Mattia Bunel]

* gnu/packages/emacs-xyz.scm (emacs-weblorg): New Variable.

Change-Id: Iae2d6cbbadec7a171e1e5b8502d4f47701d7af5b
---
 gnu/packages/emacs-xyz.scm | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 488b4cb5d7..18ae6937bb 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -38230,6 +38230,38 @@ (define-public emacs-org-static-blog
 a @samp{date} keywords, and optionally, a @samp{filetags} keyword.")
     (license license:bsd-3)))
 
+(define-public emacs-weblorg
+  (let ((commit "0db218bd6b2e083546d3a69a022dfb1a08900acd")
+        (revision "0"))
+    (package
+      (name "emacs-weblorg")
+      (version (git-version "0.1.2" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/emacs-love/weblorg")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32 "0fijrzc96p3jkq53i65bzhmxqyg28a49n21glkzb5b21agy0cdqh"))))
+      (build-system emacs-build-system)
+      (arguments
+       (list
+        #:tests? #t
+        #:test-command #~(list "emacs"
+                               "--quick"
+                               "--batch"
+                               "-l"
+                               "t/weblorg-tests.el"
+                               "-f"
+                               "ert-run-tests-batch-and-exit")))
+      (propagated-inputs (list emacs-templatel))
+      (home-page "https://emacs.love/weblorg")
+      (synopsis "Static site generator for Org mode")
+      (description "@code{Weblorg} is a static site generator for Org mode.")
+      (license license:gpl3+))))
+
 (define-public emacs-ddskk
   (let ((commit "8c47f46e38a29a0f3eabcd524268d20573102467")
         (revision "0"))

base-commit: 091131af64fd4e4e925fff829fa19097cfcdfcc5
-- 
2.47.0

[bug#74051] QA review for 74051

[Cayetano Santos via Guix-patches via]

user guix
usertag 74051 + waiting-on-contributor
thanks

Guix QA review form submission:

- watch the commit message (missing trailing dot)

    gnu: Add emacs-weblorg.

- same with home page (missing trailing slash)

    https://emacs.love/weblorg/

- synopsis and description are pretty the same, you’ll find inspiration
  on equivalent packages

-Items marked as checked:

- Commit messages
- Package builds
- Lint warnings
- Package tests
- Package style
- List dependent packages build

- New package licenses
- New package tests
- New package synopsis and descriptions