Devcontainer support #709

alaurie · 2024-12-10T02:43:37Z

This pull request introduces initial support for developing the Hugo site on AlmaLinux within a devcontainer. This setup enhances the development experience by providing a consistent, pre-configured environment directly from Visual Studio Code:

Devcontainer Features:

VSCode Extensions: Automatically installs the following extensions for optimal Hugo development:
budparr.language-hugo-vscode - Hugo syntax support
ms-python.python - Python development support
esbenp.prettier-vscode - Code formatting
yzhang.markdown-all-in-one - Enhanced Markdown editing
tamasfe.even-better-toml - TOML language support
Terminal Configuration: Sets the integrated terminal to /bin/bash for a familiar shell experience.
Port Forwarding: Configures port 1313 to be forwarded for Hugo's live server.
User Configuration: Sets remoteUser to vscode, providing a secure, non-root user environment.

Dockerfile Setup:

Base Image: Utilizes the latest AlmaLinux image for compatibility and security.
System Updates: Ensures all system packages are up-to-date.
Software Installation: Includes essential tools like git, python3, python3-pyyaml, wget, tar, shadow-utils, and sudo.
Hugo Installation: Fetches and installs the latest Hugo extended binary for dynamic site generation.
User Management: Creates and configures a vscode user with sudo privileges to enhance security and usability.
Port Exposure: Exposes port 1313 to allow Hugo's development server to be accessed externally.

This setup aims to streamline the development process by automating the environment setup, ensuring consistency across different machines, and reducing the time spent on configuration. Please review and provide feedback or approval to merge.

… into devcontainer

codyro · 2024-12-10T03:09:27Z

This looks fantastic! I'll give it a test tomorrow morning (local) to see if I can find any quirks.

What do you think about adding what you typed up in the PR to a README.md in the .devcontainer folder so people can see what it does at a glance (without looking for this PR)?

alaurie · 2024-12-10T03:55:33Z

@codyro Good idea, have added!

- You can find explanations of the changes in #709

codyro

I've made some comments/suggested changes. Feel free to use/tweak as you see fit.

I've also made a PR to your repo (https://github.com/alaurie/almalinux.org/pull/1) with the changes I commented on.

codyro · 2024-12-10T17:15:07Z

.devcontainer/devcontainer.json

+    "dockerfile": "Dockerfile",
+    "args": {
+      "VARIANT": "hugo",
+      "VERSION": "latest"


While this should be fine we should verify the site runs fine on the latest Hugo version (v0.139.4) as we currently pin the production site to 0.98.0. This was done at the time to ensure no surprise breakages between versions.

Similar with Python--we pin version 3.11, however we should be able to use the 3.12 in repositories (or we could pin 3.9 to match the devcontainer).

Ultimately I'd like to have a 1:1 environment with our production, so we have two options:

Update the devcontainer versions to match production (very old at this point)

Verify everything runs cleanly on the latest versions of Hugo and Python from the repos (3.12.x) and update the production site to match

I'm thinking option 2 is the move as I'm pretty sure most people working on the site aren't using an ancient version of Hugo..

as a note: I'm not sure the pinning you mentioned is actually working as intended. I recently (maybe as many as a few months ago) hit some snags due to outdated hugo installed on my laptop. I had to upgrade so that what I was doing would match the errors I was seeing as it deployed to dev.

I think you're correct @bennyvasquez. The latest run I can see in GitHub actions uses the latest version 0.140.0

https://github.com/AlmaLinux/almalinux.org/actions/runs/12401185107/job/34620009233

.devcontainer/devcontainer.json

.devcontainer/Dockerfile

.devcontainer/devcontainer.json

Several tweaks to #709

Revert "Several tweaks to #709"

Several tweaks to #709

- Ensures workspace is properly mounted *before* `hugo server` is ran - It attempted to run the command before the `config.yaml` was available

codyro · 2024-12-12T21:52:44Z

Documentation is critical and should be added along with these updates, so I'd like it to be part of this PR.

It doesn't affect production. It's essentially the equivalent of adding a utility script that's unused. The scope of it being in a single PR isn't really realistic.

Splitting it up will be more effective in this case.

.devcontainer/Dockerfile

pastalian · 2024-12-24T17:36:58Z

Is this intended only for docker users?
In my podman environment, it didn't work without adding --userns=keep-id to runArgs, which isn't available in docker so we can't simply add it here. I guess supporting both docker and podman out of the box is challenging.

…ng the version to test with.

alaurie · 2025-01-17T05:40:15Z

Is this intended only for docker users? In my podman environment, it didn't work without adding --userns=keep-id to runArgs, which isn't available in docker so we can't simply add it here. I guess supporting both docker and podman out of the box is challenging.

At the moment its just docker. I'll look into dual support with podman as well.

alaurie · 2025-01-17T06:27:06Z

@bennyvasquez @codyro

Documentation is critical and should be added along with these updates, so I'd like it to be part of this PR.

I've added in some further instructions in the readme.md around how the container is built and hugo live reloading on container start.

bennyvasquez · 2025-01-20T22:29:19Z

I'm good with the documentation you've created so far, @alaurie! Once we think this is ready for everyone to adopt/use for themselves, adding a mention of it to the the root README would be awesome.

alaurie · 2025-01-21T07:09:34Z

I'm good with the documentation you've created so far, @alaurie! Once we think this is ready for everyone to adopt/use for themselves, adding a mention of it to the the root README would be awesome.

I've added a section to root README and linked to the README in the devcontainer directory.

bennyvasquez

@codyro @alaurie are we waiting on anything else here? It looks to me like we're good to go. I haven't tested the docker deployment, but the steps seem sane to me, and I'm assuming we'll get bug reports if there are problems. :)

alaurie · 2025-02-18T06:39:23Z

Nothing on my end, its working and I updated the docs in the repo on this commit.

trag-bot · 2025-03-04T15:41:09Z

@trag-bot didn't find any issues in the code! ✅✨

trag-bot · 2025-03-04T15:41:27Z

Pull request summary

Introduced a Dockerfile to set up a development container using AlmaLinux as the base image.
Added installation steps for essential packages including Git, Python, and Hugo, with dynamic version support for Hugo.
Created a non-root user (alma_www_user) with sudo privileges for enhanced security during development.
Configured the devcontainer to automatically install VSCode extensions tailored for Hugo development.
Set up port forwarding for Hugo's live server on port 1313 to facilitate real-time testing.
Updated the README to include instructions for contributing, bug reporting, and local development setup.
Added a devcontainer.json file to define the development environment configuration, including terminal settings and post-creation commands.
Enhanced documentation to clarify the process for accessing the live server and utilizing hot reloading features.
Improved user experience by ensuring the integrated terminal defaults to /bin/bash.
Provided troubleshooting tips for common issues related to Docker and port connectivity.

codyro · 2025-03-04T15:42:20Z

Better late than never ;)

alaurie and others added 4 commits December 10, 2024 11:31

Added initial devcontainer support.

34b3505

Merge branch 'AlmaLinux:master' into devcontainer

4243599

Add python3-pyyaml to dockerfile.

092d756

Merge branch 'devcontainer' of https://github.com/alaurie/almalinux.org…

0bb24e4

… into devcontainer

alaurie had a problem deploying to external December 10, 2024 02:43 — with GitHub Actions Failure

codyro self-assigned this Dec 10, 2024

Add README.md to devcontainer directory.

ae1cf2a

alaurie had a problem deploying to external December 10, 2024 03:55 — with GitHub Actions Failure

codyro self-requested a review December 10, 2024 16:12

Several tweaks to #709

5ccb7da

- You can find explanations of the changes in #709

codyro requested changes Dec 10, 2024

View reviewed changes

codyro added the enhancement New feature or request label Dec 10, 2024

Merge pull request #1 from codyro/pr-709-devcontainer-tweaks

177be2d

Several tweaks to #709

alaurie had a problem deploying to external December 10, 2024 21:54 — with GitHub Actions Failure

Merge branch 'AlmaLinux:master' into devcontainer

7738274

alaurie had a problem deploying to external December 11, 2024 00:30 — with GitHub Actions Failure

alaurie added 2 commits December 11, 2024 10:40

Revert "Several tweaks to #709"

8af8b91

Merge pull request #2 from alaurie/revert-1-pr-709-devcontainer-tweaks

f80f85d

Revert "Several tweaks to #709"

alaurie had a problem deploying to external December 11, 2024 00:40 — with GitHub Actions Failure

Merge pull request #1 from codyro/pr-709-devcontainer-tweaks

36d5a7b

Several tweaks to #709

alaurie had a problem deploying to external December 11, 2024 01:22 — with GitHub Actions Failure

Remove hugo serve command and set overrideCommand to true.

010c674

alaurie had a problem deploying to external December 11, 2024 05:33 — with GitHub Actions Failure

Add docker extension to vscode.

beb5103

alaurie had a problem deploying to external December 11, 2024 06:03 — with GitHub Actions Failure

codyro added 3 commits December 11, 2024 10:07

Testing to see why CMD is failing with hugo server command

9474397

Leverage devcontainer postStartCommand hook

73f6d13

- Ensures workspace is properly mounted *before* `hugo server` is ran - It attempted to run the command before the `config.yaml` was available

Update the order of operations to make hugo happy

26b3d55

codyro mentioned this pull request Dec 12, 2024

Update Hugo to latest version #712

Closed

javihernandez reviewed Dec 13, 2024

View reviewed changes

.devcontainer/Dockerfile Outdated Show resolved Hide resolved

Corrected arg naming and added specific version downloading for pinni…

cfbc2aa

…ng the version to test with.

alaurie had a problem deploying to external January 17, 2025 05:39 — with GitHub Actions Failure

Updated readme.md for recent changes.

3dfec6d

alaurie had a problem deploying to external January 17, 2025 06:23 — with GitHub Actions Failure

codyro self-requested a review January 18, 2025 16:46

Added devcontainer to main readme.me

68625ec

alaurie had a problem deploying to external January 21, 2025 07:03 — with GitHub Actions Failure

Corrected devcontainer readme link

7d8d0d0

alaurie had a problem deploying to external January 21, 2025 07:08 — with GitHub Actions Failure

bennyvasquez mentioned this pull request Jan 21, 2025

Pin hugo version #741

Merged

Set hugo version to 0.141.0 as latest pinning.

71e314c

alaurie had a problem deploying to external January 21, 2025 22:30 — with GitHub Actions Failure

bennyvasquez approved these changes Feb 17, 2025

View reviewed changes

codyro approved these changes Mar 4, 2025

View reviewed changes

Merge branch 'master' into devcontainer

2a0dcff

codyro had a problem deploying to external March 4, 2025 15:40 — with GitHub Actions Failure

codyro merged commit 3313459 into AlmaLinux:master Mar 4, 2025
1 of 2 checks passed

codyro assigned alaurie Mar 4, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Devcontainer support #709

Devcontainer support #709

alaurie commented Dec 10, 2024

codyro commented Dec 10, 2024

alaurie commented Dec 10, 2024

codyro left a comment •

edited

Loading

codyro Dec 10, 2024

bennyvasquez Dec 12, 2024

alaurie Dec 19, 2024 •

edited

Loading

codyro commented Dec 12, 2024 •

edited

Loading

pastalian commented Dec 24, 2024

alaurie commented Jan 17, 2025

alaurie commented Jan 17, 2025 •

edited

Loading

bennyvasquez commented Jan 20, 2025

alaurie commented Jan 21, 2025

bennyvasquez left a comment

alaurie commented Feb 18, 2025

trag-bot bot commented Mar 4, 2025

trag-bot bot commented Mar 4, 2025

codyro commented Mar 4, 2025

Devcontainer support #709

Devcontainer support #709

Conversation

alaurie commented Dec 10, 2024

Devcontainer Features:

Dockerfile Setup:

codyro commented Dec 10, 2024

alaurie commented Dec 10, 2024

codyro left a comment • edited Loading

Choose a reason for hiding this comment

codyro Dec 10, 2024

Choose a reason for hiding this comment

bennyvasquez Dec 12, 2024

Choose a reason for hiding this comment

alaurie Dec 19, 2024 • edited Loading

Choose a reason for hiding this comment

codyro commented Dec 12, 2024 • edited Loading

pastalian commented Dec 24, 2024

alaurie commented Jan 17, 2025

alaurie commented Jan 17, 2025 • edited Loading

bennyvasquez commented Jan 20, 2025

alaurie commented Jan 21, 2025

bennyvasquez left a comment

Choose a reason for hiding this comment

alaurie commented Feb 18, 2025

trag-bot bot commented Mar 4, 2025

trag-bot bot commented Mar 4, 2025

Pull request summary

codyro commented Mar 4, 2025

codyro left a comment •

edited

Loading

alaurie Dec 19, 2024 •

edited

Loading

codyro commented Dec 12, 2024 •

edited

Loading

alaurie commented Jan 17, 2025 •

edited

Loading