Turn theme into a hugo module #134

deining · 2022-03-05T07:40:50Z

This PR turns hugo-fresh into a hugo module. This way, the theme can pull in dependency bulma as go module.

With this PR in place, setting up a new site based on hugo-fresh can be done via:

hugo new site my-site
cd my-site
hugo mod init github.com/me/my-site
hugo mod get github.com/StefMa/hugo-fresh #optional
echo 'theme = "github.com/StefMa/hugo-fresh" >> config.toml
hugo serve

Note: This PR is work in progress. The concept works: with this PR applied, you can preview the exampleSite simply via hugo server (no themesDir=../.. needed any more). If you like the idea, I'm willing to refine the implementation and add the documentation for the new route to install hugo-fresh.

StefMa · 2022-03-08T06:37:15Z

Hey, thanks for the contribution again! I definitely like the idea. Feel free to continue with the implementation.

…

On Sat, Mar 5, 2022, 8:41 AM Andreas Deininger ***@***.***> wrote: This PR turns hugo-fresh into a hugo module. This way, the theme can pull in dependency bulma as go module. With this PR in place, setting up a new site based on hugo-fresh can be done via: hugo new site my-site cd my-site hugo mod init github.com/me/my-site hugo mod get github.com/StefMa/hugo-fresh #optional echo 'theme = "github.com/StefMa/hugo-fresh" >> config.toml hugo serve *Note:* This PR is work in progress. The concept works: with this PR applied, you can preview the exampleSite simply via hugo server (no themesDir=../.. needed any more). If you like the idea, I'm willing to refine the implementation and add the documentation for the new route to install hugo-fresh. ------------------------------ You can view, comment on, or merge this pull request online at: #134 Commit Summary - 2a0489b <2a0489b> Turn theme into a hugo module File Changes (6 files <https://github.com/StefMa/hugo-fresh/pull/134/files>) - *A* config.yaml <https://github.com/StefMa/hugo-fresh/pull/134/files#diff-d8d0422389f03d783e32e627250fe29834bd09c6361640d1ff00661dd6820034> (26) - *M* exampleSite/config.yaml <https://github.com/StefMa/hugo-fresh/pull/134/files#diff-1926bed36200257684beefb9e338d8dc0679b7226f1cb4290fb677139853dfb9> (3) - *A* exampleSite/go.mod <https://github.com/StefMa/hugo-fresh/pull/134/files#diff-5bed2c958464666aa841aecfa747db471387119abc35bb3fbb729565aaac8818> (7) - *A* exampleSite/go.sum <https://github.com/StefMa/hugo-fresh/pull/134/files#diff-f6be75f6781e07f5e910f0302efdca04702663d15147714c0d422cc7fadbf156> (3) - *A* go.mod <https://github.com/StefMa/hugo-fresh/pull/134/files#diff-33ef32bf6c23acb95f5902d7097b7a1d5128ca061167ec0716715b0b9eeaa5f6> (5) - *A* go.sum <https://github.com/StefMa/hugo-fresh/pull/134/files#diff-3295df7234525439d778f1b282d146a4f1ff6b415248aaac074e8042d9f42d63> (2) Patch Links: - https://github.com/StefMa/hugo-fresh/pull/134.patch - https://github.com/StefMa/hugo-fresh/pull/134.diff — Reply to this email directly, view it on GitHub <#134>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACOBQ67XP2IUIY24N5BTZR3U6MFY3ANCNFSM5P7K7MYA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

StefMa · 2023-02-26T12:01:16Z

Hey @deining .
Are you still interested in this idea?
What are the to-do`s to finish this up?
Camn I help you with someting?

deining · 2023-02-26T19:01:53Z

Hey @deining . Are you still interested in this idea?

Yes, I am. Sorry, this flew under my radar for a long time!

What are the to-do`s to finish this up?

I realized that bulma is at version 0.9.4 meanwhile (my original PR was for 0.9.3). I corrected my PR, it now targets bulma 0.9.4.
So implementation wise, everything is ready to be rolled out 😄 I just removed the draft status from this PR and would like to see this merged soon.

Camn I help you with someting?

Yes. CircleCi now fails with this message:

Error: we found a go.mod file in your project, but you need to install Go to use it.

Can you add go to the CI workflow, please?

Furthermore: With my PR in place, we have two installation approaches now: hugo module vs. git submodule. The problem with that is, that both approaches are out sync concerning bulma version: hugo module is at latest bulma version 0.9.4, while HEAD of repo is at 0.7.0. Both should be in sync however, as requested in #114 and addressed in #133 by me (unfortunately my PR is outdated now).

So we have two choices:

update HEAD of repo to latest bulma version 0.9.4 (if wanted, can you take that on, please?)
drop support for git submodule installations altogether and subsequently remove bulma files from repo

You are the repo owner, you have to decide which of the tweo proposed ways you want to go.

Two more notes:

Documentation wise, I find it strange that install instructions in /docs/content/getstarted.md, but neither in the exampleSite nor in the https://hugo-fresh.vercel.app/ nor in README.md. This somehow hides away the whole documentation from the user. Was this done on purpose? If so, what was the motivation?
I realized that the repo contains parts of the resource cache in resources folder. According to this comment, this is a good thing. If you update the bulma files inside this repo, the files inside this directory should be updated as well.

StefMa · 2023-02-27T07:24:31Z

Thanks @deining and thank you for all the information you provide here 🙏

Regarding CircleCI:
I would suggest we wait until we moved to GH Actions (#157 (comment)).

Regarding two versions (submodule and modules) I would go the "all-in hugo modules" way.
Let's drop submodules 🗑️.
Do you want to take care for this in this PR as well?

Documentation wise, I find it strange that install instructions in /docs/content/getstarted.md, but neither in the exampleSite nor in the https://hugo-fresh.vercel.app/ nor in README.md. This somehow hides away the whole documentation from the user. Was this done on purpose? If so, what was the motivation?

Yep, I also realized this and probably move the documentation more prominent to the README.
Thanks for the hint 👍 I will think about it ...

I realized that the repo contains parts of the resource cache in resources folder. According to this comment, this is a good thing. If you update the bulma files inside this repo, the files inside this directory should be updated as well.

You mean I should not be part of the repository, right? 🤔
If so, please don't hesitate to remove it in this PR as well 🙂

StefMa · 2023-02-27T07:24:31Z

Thanks @deining and thank you for all the information you provide here 🙏

Regarding CircleCI:
I would suggest we wait until we oved to GH Actions (#157 (comment)).

Regarding two versions (submodule and modules) I would go the "all-in hugo modules" way.
Let's drop submodules 🗑️.
Do you want to take care for this in this PR as well?

Documentation wise, I find it strange that install instructions in /docs/content/getstarted.md, but neither in the exampleSite nor in the https://hugo-fresh.vercel.app/ nor in README.md. This somehow hides away the whole documentation from the user. Was this done on purpose? If so, what was the motivation?

Yep, I also realized this and probably move the documentation more prominent to the README.
Thanks for the hint 👍 I will think about it ...

I realized that the repo contains parts of the resource cache in resources folder. According to this comment, this is a good thing. If you update the bulma files inside this repo, the files inside this directory should be updated as well.

You mean it should not be part of the repository, right? 🤔
If so, please don't hesitate to remove it in this PR as well 🙂

deining · 2023-02-27T09:00:41Z

Regarding two versions (submodule and modules) I would go the "all-in hugo modules" way. Let's drop submodules 🗑️.

Wise decision!

Do you want to take care for this in this PR as well?

Yes, I will come back to this once migration to GitHub actions is done!

deining · 2023-02-27T10:56:17Z

I removed all remnants of the git submodule + local bulma installation I could find.

Yep, I also realized this and probably move the documentation more prominent to the README.

That's a goo idea and would, go ahead with this.

I'm done here too, handing over to your for approval/finalization.

This way, the theme pulls in dependency 'bulma' as go module

StefMa

Finally, we did it 🚀
Thanks again @deining.
This moves the theme to the next level.

StefMa · 2023-03-03T09:31:54Z

config.yaml

+# and mount points are declared
+module:
+  imports:
+  - path: github.com/jgthms/bulma


A follow-up question regarding this here @deining .

We now pull always the latest main/master branch from bulma right? 🤔
Can we also specify a git tag? 🤔
Like github.com/jgthms/[email protected]
I guess this is more stable than always pulling a develop branch?! 🤔

We now pull always the latest main/master branch from bulma right?

No. we pull in 0.9.4 right now.

The bulma version used is defined in go.mod:

hugo-fresh/go.mod

Line 5 in 7987c63

require github.com/jgthms/bulma v0.0.0-20220508134905-3e00a8e6d0d0 // indirect

To update bulma inside your theme use this command:

hugo mod get -u github.com/jgthms/bulma@9734c65c100 # commit hash

Instead of a commit, you can also use a version (the tag should have leading v though (e.g. v0.9.4)):

As an example, the command below can be used by users of your theme to update their theme version used:

hugo mod get -u github.com/StefMa/[email protected]

This only works of course if you start using tags like vn.n. What about tagging this first module version with v0.1 or so?

Hope that clarifies things!

Thank you very much.
Yes, that helped quite a lot.
Its sad that the go.mod didn't show the git tag but the hash instead 😭

Its sad that the go.mod didn't show the git tag but the hash instead

If the name of the tag in the bulma repo were v0.9.4 instead of 0.9.4, you would see it.
So if you want that users of your theme see the tag instead of the hash, but better tag the inital module release with v1.0instead of 1.0.

Thank you very much again 🙂
Here we are: https://github.com/StefMa/hugo-fresh/releases/tag/v1.0.0

With that I have a go.mod and go.sum client like that:

// go.mod require github.com/StefMa/hugo-fresh v1.0.0 // indirect // go.sum github.com/StefMa/hugo-fresh v1.0.0 h1:Nxo9WtzfBlaFi1G8NEHQLReJQz+Dn4jRxec+lMrPG6k= github.com/StefMa/hugo-fresh v1.0.0/go.mod h1:yRzHyco0bfnITjvq7rfAiOADfGMrDlM0kXeKBllUJEc= github.com/jgthms/bulma v0.0.0-20220508134905-3e00a8e6d0d0/go.mod h1:89FLBKXYFKfOKAoDeUT26V0pHGwzr205cMXAEqtAVOI=

deining marked this pull request as draft March 8, 2022 07:36

deining force-pushed the module branch 2 times, most recently from bf574b7 to ea2b8bd Compare February 26, 2023 18:21

deining marked this pull request as ready for review February 26, 2023 19:02

StefMa force-pushed the master branch 11 times, most recently from 7c769b3 to 1907474 Compare February 28, 2023 13:22

StefMa changed the title ~~WIP: Turn theme into a hugo module~~ Turn theme into a hugo module Mar 3, 2023

StefMa force-pushed the module branch 3 times, most recently from 7aa10b3 to 34ca4a5 Compare March 3, 2023 09:16

deining and others added 4 commits March 3, 2023 10:20

Turn theme into a hugo module

c1531cb

This way, the theme pulls in dependency 'bulma' as go module

Dropping bulma which is now pulled in as module

c6652ee

Remove installation as git submodule (config, doc)

cac6a3b

Update generated resources (bulma 0.9.4)

488276c

Fix vercel deployment

814f747

StefMa force-pushed the module branch from 34ca4a5 to 814f747 Compare March 3, 2023 09:23

Merge remote-tracking branch 'origin/master' into module

d4138c0

StefMa approved these changes Mar 3, 2023

View reviewed changes

StefMa merged commit 7987c63 into StefMa:master Mar 3, 2023

This was referenced Mar 3, 2023

Bump bulma to latest version 0.9.3 #133

Closed

Update bulma #114

Closed

StefMa reviewed Mar 3, 2023

View reviewed changes

deining deleted the module branch March 3, 2023 13:39

deining mentioned this pull request Mar 19, 2023

[feature_request]: hugo module management jgazeau/shadocs#147

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Turn theme into a hugo module #134

Turn theme into a hugo module #134

deining commented Mar 5, 2022

StefMa commented Mar 8, 2022 via email

StefMa commented Feb 26, 2023

deining commented Feb 26, 2023 •

edited

Loading

StefMa commented Feb 27, 2023

StefMa commented Feb 27, 2023 •

edited

Loading

deining commented Feb 27, 2023

deining commented Feb 27, 2023

StefMa left a comment

StefMa Mar 3, 2023

deining Mar 3, 2023

StefMa Mar 4, 2023

deining Mar 4, 2023

StefMa Mar 5, 2023

Turn theme into a hugo module #134

Turn theme into a hugo module #134

Conversation

deining commented Mar 5, 2022

StefMa commented Mar 8, 2022 via email

StefMa commented Feb 26, 2023

deining commented Feb 26, 2023 • edited Loading

StefMa commented Feb 27, 2023

StefMa commented Feb 27, 2023 • edited Loading

deining commented Feb 27, 2023

deining commented Feb 27, 2023

StefMa left a comment

Choose a reason for hiding this comment

StefMa Mar 3, 2023

Choose a reason for hiding this comment

deining Mar 3, 2023

Choose a reason for hiding this comment

StefMa Mar 4, 2023

Choose a reason for hiding this comment

deining Mar 4, 2023

Choose a reason for hiding this comment

StefMa Mar 5, 2023

Choose a reason for hiding this comment

deining commented Feb 26, 2023 •

edited

Loading

StefMa commented Feb 27, 2023 •

edited

Loading