Skip to content

[CI] Migrate to npm-managed local Hugo and standardise Makefile targets #407

@hebypaul

Description

@hebypaul

Current Behavior

Currently, local development for exoscale-academy relies on a globally installed Hugo binary or uses inconsistent npx invocations. This can lead to version mismatch issues between contributors and CI environments, causing build failures or discrepancies. Additionally, some documentation might reference outdated Makefile targets.

Desired Behavior

A contained, highly reproducible local development environment where dependencies are strictly managed. Just like the main Meshery documentation, running make setup should fetch the correct hugo-extended NPM dependency. Subsequent commands (make site, make build, make serve, etc.) should automatically route to this local binary, eliminating the need for a global Hugo installation.

Implementation

This approach ports over the standardized build processes established in other Layer5 repositories to the exoscale-academy repository.

Specific changes should include:

  • Makefile: Add a check-deps target to validate npm and the local hugo binary before execution. Reroute build, site, serve, clean, and theme-update to trigger npm run scripts.
  • package.json: Add dev:* scripts (e.g., dev:build, dev:clean, dev:serve, dev:site) to explicitly handle Hugo commands with the correct flags, stripping out unnecessary npx prefixes. Update package update scripts to use npm exec instead of npx.
  • Documentation: Update README.md and CONTRIBUTING.md to remove references to outdated targets and emphasize the make setup -> make site workflow.

Acceptance Tests

  • make setup installs the local hugo-extended dependency cleanly.
  • make site successfully spins up the local development server using the NPM-managed binary.
  • make clean correctly wipes the build cache.
  • A user without a globally installed Hugo can build the site from a fresh clone.

Contributor Guide and Resources

Metadata

Metadata

Assignees

Labels

area/ciContinuous integration | Build and release

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions