From 55eb67848e205bdd452445b2700450d9c5106ac5 Mon Sep 17 00:00:00 2001 From: ian Date: Thu, 27 Feb 2025 03:22:02 +0000 Subject: [PATCH 1/2] Update local build environment and packages --- .devcontainer/Dockerfile | 15 ----- .devcontainer/devcontainer.json | 32 ++++++---- .github/dependabot.yml | 12 ++++ .vscode/settings.json | 3 + Gemfile | 11 +++- Gemfile.lock | 101 ++++++++++++++++++++------------ 6 files changed, 107 insertions(+), 67 deletions(-) delete mode 100644 .devcontainer/Dockerfile create mode 100644 .github/dependabot.yml create mode 100644 .vscode/settings.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile deleted file mode 100644 index df583527..00000000 --- a/.devcontainer/Dockerfile +++ /dev/null @@ -1,15 +0,0 @@ -FROM ruby:2.6.3-buster - -# Avoid warnings by switching to noninteractive -ENV DEBIAN_FRONTEND=noninteractive - -# Configure apt and install packages -RUN apt-get update \ - && apt-get -y install --no-install-recommends apt-utils 2>&1 \ - # - # Verify git and needed tools are installed - && apt-get install -y git procps \ - && gem install bundler -# Switch back to dialog for any ad-hoc use of apt-get -ENV DEBIAN_FRONTEND=dialog -ENV SHELL /bin/bash \ No newline at end of file diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 4b2a6d24..964d46fe 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,12 +1,22 @@ - +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/jekyll { - "name": "Open F# sample", - "dockerFile": "Dockerfile", - "appPort": 4000, - "extensions": [ - ], - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, - "postCreateCommand": "bundle install" -} \ No newline at end of file + "name": "Jekyll", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "mcr.microsoft.com/devcontainers/jekyll:2-bullseye" + + // Features to add to the dev container. More info: https://containers.dev/features. + // "features": {}, + + // Use 'forwardPorts' to make a list of ports inside the container available locally. + // "forwardPorts": [], + + // Uncomment the next line to run commands after the container is created. + // "postCreateCommand": "jekyll --version" + + // Configure tool-specific properties. + // "customizations": {}, + + // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. + // "remoteUser": "root" +} diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 00000000..f33a02cd --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for more information: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +# https://containers.dev/guide/dependabot + +version: 2 +updates: + - package-ecosystem: "devcontainers" + directory: "/" + schedule: + interval: weekly diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..544b7b4d --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + +} \ No newline at end of file diff --git a/Gemfile b/Gemfile index dc4a95ee..70ebb5fe 100644 --- a/Gemfile +++ b/Gemfile @@ -8,7 +8,7 @@ source "https://rubygems.org" # # This will help ensure the proper Jekyll version is running. # Happy Jekylling! -gem "jekyll", "~> 3.8.5" +gem "jekyll", "~> 4.4.1" # This is the default theme for new Jekyll sites. You may change this to anything you like. gem "minima", "~> 2.0" @@ -19,7 +19,7 @@ gem "minima", "~> 2.0" # If you have any plugins, put them here! group :jekyll_plugins do - gem "jekyll-feed", "~> 0.6" + gem "jekyll-feed", "~> 0.17" end # Windows does not include zoneinfo files, so bundle the tzinfo-data gem @@ -29,3 +29,10 @@ gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] gem "wdm", "~> 0.1.0" if Gem.win_platform? gem "jekyll-redirect-from", "~> 0.15.0" + +# Add the following lines to include the missing dependencies +gem 'webrick' +gem 'rexml' +gem 'csv' +gem 'base64' +gem 'bigdecimal' diff --git a/Gemfile.lock b/Gemfile.lock index df8e4581..c7ebfd4f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,77 +1,100 @@ GEM remote: https://rubygems.org/ specs: - addressable (2.8.0) - public_suffix (>= 2.0.2, < 5.0) + addressable (2.8.7) + public_suffix (>= 2.0.2, < 7.0) + base64 (0.2.0) + bigdecimal (3.1.9) colorator (1.1.0) - concurrent-ruby (1.1.5) - em-websocket (0.5.1) + concurrent-ruby (1.3.5) + csv (3.3.2) + em-websocket (0.5.3) eventmachine (>= 0.12.9) - http_parser.rb (~> 0.6.0) + http_parser.rb (~> 0) eventmachine (1.2.7) - ffi (1.11.1) + ffi (1.17.1) forwardable-extended (2.6.0) - http_parser.rb (0.6.0) - i18n (0.9.5) + google-protobuf (4.29.3) + bigdecimal + rake (>= 13) + http_parser.rb (0.8.0) + i18n (1.14.7) concurrent-ruby (~> 1.0) - jekyll (3.8.6) + jekyll (4.4.1) addressable (~> 2.4) + base64 (~> 0.2) colorator (~> 1.0) + csv (~> 3.0) em-websocket (~> 0.5) - i18n (~> 0.7) - jekyll-sass-converter (~> 1.0) + i18n (~> 1.0) + jekyll-sass-converter (>= 2.0, < 4.0) jekyll-watch (~> 2.0) - kramdown (~> 1.14) + json (~> 2.6) + kramdown (~> 2.3, >= 2.3.1) + kramdown-parser-gfm (~> 1.0) liquid (~> 4.0) - mercenary (~> 0.3.3) + mercenary (~> 0.3, >= 0.3.6) pathutil (~> 0.9) - rouge (>= 1.7, < 4) + rouge (>= 3.0, < 5.0) safe_yaml (~> 1.0) - jekyll-feed (0.12.1) + terminal-table (>= 1.8, < 4.0) + webrick (~> 1.7) + jekyll-feed (0.17.0) jekyll (>= 3.7, < 5.0) jekyll-redirect-from (0.15.0) jekyll (>= 3.3, < 5.0) - jekyll-sass-converter (1.5.2) - sass (~> 3.4) + jekyll-sass-converter (3.1.0) + sass-embedded (~> 1.75) jekyll-seo-tag (2.6.1) jekyll (>= 3.3, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - kramdown (1.17.0) - liquid (4.0.3) - listen (3.1.5) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - ruby_dep (~> 1.2) - mercenary (0.3.6) - minima (2.5.0) - jekyll (~> 3.5) + json (2.10.1) + kramdown (2.5.1) + rexml (>= 3.3.9) + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.4) + listen (3.9.0) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + minima (2.5.2) + jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (4.0.6) - rb-fsevent (0.10.3) - rb-inotify (0.10.0) + public_suffix (6.0.1) + rake (13.2.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) ffi (~> 1.0) - rouge (3.7.0) - ruby_dep (1.5.0) + rexml (3.4.1) + rouge (4.5.1) safe_yaml (1.0.5) - sass (3.7.4) - sass-listen (~> 4.0.0) - sass-listen (4.0.0) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) + sass-embedded (1.85.1) + google-protobuf (~> 4.29) + rake (>= 13) + terminal-table (3.0.2) + unicode-display_width (>= 1.1.1, < 3) + unicode-display_width (2.6.0) + webrick (1.9.1) PLATFORMS ruby DEPENDENCIES - jekyll (~> 3.8.5) - jekyll-feed (~> 0.6) + base64 + bigdecimal + csv + jekyll (~> 4.4.1) + jekyll-feed (~> 0.17) jekyll-redirect-from (~> 0.15.0) minima (~> 2.0) + rexml tzinfo-data + webrick BUNDLED WITH - 2.0.2 + 2.6.5 From dcb6ad30937da30357ea130979081c71c1cacd4d Mon Sep 17 00:00:00 2001 From: ian Date: Thu, 27 Feb 2025 04:06:33 +0000 Subject: [PATCH 2/2] Add development instructions to the README --- README.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b795d886..58eca52c 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,35 @@ This repository hosts [The F# Software Foundation web site](https://fsharp.org/). Pull requests are welcome. The web site code is hosted in the `gh-pages` branch and is created using the tools provided by GitHub: - * Switch to [the `gh-pages` branch](https://github.com/fsharp/fsharp.org/tree/gh-pages) - * Read [documentation for Github Pages](https://help.github.com/categories/20/articles) - * The site is using [Jekyll for templating](http://jekyllrb.com/docs/usage/) +* Switch to [the `gh-pages` branch](https://github.com/fsharp/fsharp.org/tree/gh-pages) +* Read [documentation for Github Pages](https://help.github.com/categories/20/articles) +* The site is using [Jekyll for templating](http://jekyllrb.com/docs/usage/) +## Development +The easiest way to get started with this repository is by using the supplied dev container. + +### Using the Dev Container + +1. Open the repository in Visual Studio Code. +2. When prompted, reopen the repository in the dev container. +3. The dev container will automatically set up the development environment. + +**Summary of using a dev container:** +A dev container is a pre-configured development environment that includes all the necessary tools and dependencies. It allows you to start developing without having to manually set up your environment. + +If not using VSCode, consult your preferred IDE's documentation for instructions. + +To start the development server, run the following command: + +```sh +bundle exec jekyll serve +``` + +Or, to enable live reloading: + +```sh +bundle exec jekyll serve -l +``` + +The site will be available at `http://localhost:4000`