bridgetown-core 1.0.0.beta3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e42f164cec4d31c4904ed8f35ea1ac8079a60d79ec89fb97946b4e9799e65a
-  data.tar.gz: a590bd4e904bbbd89d0fa57541280fc9c01c11bbac5974261940020a4bb9d832
+  metadata.gz: fdb62333635d80ceb9561a0cd9be68f0220ea729c8ac4505bb8e4460894075e1
+  data.tar.gz: f7377127b4d64846e694d8ba4c032706ed161ea1595cf8dbf3eca3d2b6e4692d
 SHA512:
-  metadata.gz: 7a6654c80468f31af2d728bcef3820f1c265e67df5f0e8c92e8d495c4376d309da919d3c31a69b69ac87ad3b9d6849f93ec45e69630f2875e43c5282dbd54d4d
-  data.tar.gz: 709855c6285071f112206bf7f2a96f5956abc74f35c8bbf591f2b13f222a6e75e83158d93062f948d34f878ee62048747a6c9337710ebe9f0da2ef4f18db25bd
+  metadata.gz: 051a34337053c1370745d37a7cc3def36e1623193e4c03e0b1006d06280303ad5442c289465185314f916dbcf2aa1b1123990ca196041b03bf3804a03b36f695
+  data.tar.gz: d5adcc3f8c7c7938bbc220329c002c7cea281f4e21f8ea2bab685dabaffe48c5acca3998482d1e0ec6d0c7c172751c0c6b34481821f51b5d1ccc687b137e55a5

data/lib/bridgetown-core/commands/esbuild/esbuild.config.js

@@ -5,23 +5,27 @@ const outputFolder = "output"
 
 // You can customize this as you wish, perhaps to add new esbuild plugins.
 //
-// Eg:
+// ```
+// const path = require("path")
+// const esbuildCopy = require('esbuild-plugin-copy').default
+// const esbuildOptions = {
+//   plugins: [
+//     esbuildCopy({
+//       assets: {
+//         from: [path.resolve(__dirname, 'node_modules/somepackage/files/*')],
+//         to: [path.resolve(__dirname, 'output/_bridgetown/somepackage/files')],
+//       },
+//       verbose: false
+//     }),
+//   ]
+// }
+// ```
 //
-//  ```
-//  const path = require("path")
-//  const esbuildCopy = require('esbuild-plugin-copy').default
-//  const esbuildOptions = {
-//    plugins: [
-//      esbuildCopy({
-//        assets: {
-//          from: [path.resolve(__dirname, 'node_modules/somepackage/files/*')],
-//          to: [path.resolve(__dirname, 'output/_bridgetown/somepackage/files')],
-//        },
-//        verbose: false
-//      }),
-//    ]
-//  }
-//  ```
+// You can also support custom base_path deployments via changing `publicPath`.
+//
+// ```
+// const esbuildOptions = { publicPath: "/my_subfolder/_bridgetown/static" }
+// ```
 const esbuildOptions = {}
 
 build(outputFolder, esbuildOptions)

data/lib/bridgetown-core/configurations/gh-pages/gh-pages.yml

@@ -0,0 +1,33 @@
+name: Deploy to GitHub pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+          cache: "yarn"
+      - run: yarn install
+
+      - name: Build
+        run: bin/bridgetown deploy
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./output

data/lib/bridgetown-core/configurations/gh-pages.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+`bundle lock --add-platform x86_64-linux`
+copy_file in_templates_dir("gh-pages.yml"), ".github/workflows/gh-pages.yml"
+
+# rubocop:disable Layout/LineLength
+say "🎉 A GitHub action to deploy your site to GitHub pages has been configured!"
+say ""
+
+say "🛠️  After pushing the action, go to your repository settings and configure GitHub Pages to deploy from the branch `gh-pages`."
+say ""
+
+say "You'll likely also need to set `base_path` in your `bridgetown.config.yml` to your repository's name. If you do this you'll need to use the `relative_url` helper for all links and assets in your HTML."
+say "If you're using esbuild for frontend assets, edit `esbuild.config.js` to update `publicPath`."
+say ""
+# rubocop:enable Layout/LineLength

data/lib/bridgetown-core/rack/roda.rb

@@ -48,8 +48,6 @@ module Bridgetown
         Bridgetown::Current.preloaded_configuration ||=
           self.class.opts[:bridgetown_preloaded_config]
 
-        request.public
-
         request.root do
           output_folder = Bridgetown::Current.preloaded_configuration.destination
           File.read(File.join(output_folder, "index.html"))

data/lib/bridgetown-core/rack/routes.rb

@@ -41,6 +41,24 @@ module Bridgetown
         end
 
         def start!(roda_app)
+          if Bridgetown::Current.preloaded_configuration.base_path == "/"
+            load_all_routes roda_app
+            return
+          end
+
+          # Support custom base_path configurations
+          roda_app.request.on(
+            Bridgetown::Current.preloaded_configuration.base_path.delete_prefix("/")
+          ) do
+            load_all_routes roda_app
+          end
+
+          nil
+        end
+
+        def load_all_routes(roda_app)
+          roda_app.request.public
+
           if Bridgetown.env.development? &&
               !Bridgetown::Current.preloaded_configuration.skip_live_reload
             setup_live_reload roda_app
@@ -50,11 +68,9 @@ module Bridgetown
             klass.merge roda_app
           end
 
-          if defined?(Bridgetown::Routes::RodaRouter)
-            Bridgetown::Routes::RodaRouter.start!(roda_app)
-          end
+          return unless defined?(Bridgetown::Routes::RodaRouter)
 
-          nil
+          Bridgetown::Routes::RodaRouter.start!(roda_app)
         end
 
         def setup_live_reload(app) # rubocop:disable Metrics/AbcSize

data/lib/bridgetown-core/utils.rb

@@ -457,7 +457,7 @@ module Bridgetown
       code = <<~JAVASCRIPT
         let lastmod = 0
         function startReloadConnection() {
-          const evtSource = new EventSource("/_bridgetown/live_reload")
+          const evtSource = new EventSource("#{site.base_path(strip_slash_only: true)}/_bridgetown/live_reload")
           evtSource.onmessage = event => {
             if (event.data == "reloaded!") {
               location.reload()

data/lib/bridgetown-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "1.0.0.beta3"
+  VERSION = "1.0.0"
   CODE_NAME = "Pearl"
 end

data/lib/site_template/Gemfile.erb

@@ -26,4 +26,4 @@ gem "bridgetown", "~> <%= Bridgetown::VERSION %>"
 
 # Puma is a Rack-compatible server used by Bridgetown
 # (you can optionally limit this to the "development" group)
-gem "puma", "~> 5.5"
+gem "puma", "~> 5.6"

data/lib/site_template/TEMPLATES/erb/_components/shared/navbar.erb

@@ -1,11 +1,11 @@
 <header>
-  <img src="/images/logo.svg" alt="Logo" />
+  <img src="<%= relative_url '/images/logo.svg' %>" alt="Logo" />
 </header>
 
 <nav>
   <ul>
-    <li><a href="/">Home</a></li>
-    <li><a href="/about">About</a></li>
-    <li><a href="/posts">Posts</a></li>
+    <li><a href="<%= relative_url '/' %>">Home</a></li>
+    <li><a href="<%= relative_url '/about' %>">About</a></li>
+    <li><a href="<%= relative_url '/posts' %>">Posts</a></li>
   </ul>
 </nav>

data/lib/site_template/TEMPLATES/liquid/_components/navbar.liquid

@@ -1,11 +1,11 @@
 <header>
-  <img src="/images/logo.svg" alt="Logo" />
+  <img src="{{ '/images/logo.svg' | relative_url }}" alt="Logo" />
 </header>
 
 <nav>
   <ul>
-    <li><a href="/">Home</a></li>
-    <li><a href="/about">About</a></li>
-    <li><a href="/posts">Posts</a></li>
+    <li><a href="{{ '/' | relative_url }}">Home</a></li>
+    <li><a href="{{ '/about' | relative_url }}">About</a></li>
+    <li><a href="{{ '/posts' | relative_url }}">Posts</a></li>
   </ul>
 </nav>

data/lib/site_template/TEMPLATES/serbea/_components/shared/navbar.serb

@@ -1,11 +1,11 @@
 <header>
-  <img src="/images/logo.svg" alt="Logo" />
+  <img src="{{ '/images/logo.svg' | relative_url }}" alt="Logo" />
 </header>
 
 <nav>
   <ul>
-    <li><a href="/">Home</a></li>
-    <li><a href="/about">About</a></li>
-    <li><a href="/posts">Posts</a></li>
+    <li><a href="{{ '/' | relative_url }}">Home</a></li>
+    <li><a href="{{ '/about' | relative_url }}">About</a></li>
+    <li><a href="{{ '/posts' | relative_url }}">Posts</a></li>
   </ul>
 </nav>

data/lib/site_template/bridgetown.config.yml

@@ -19,8 +19,12 @@ url: "" # the base hostname & protocol for your site, e.g. https://example.com
 permalink: pretty
 
 # Other options you might want to investigate:
-# 
-# base_path: "/" # the subpath of your site, e.g. /blog
+#
+# base_path: "/" # the subpath of your site, e.g. /blog. If you set this option,
+# ensure you use the `relative_url` helper for all links and assets in your HTML.
+# If you're using esbuild for frontend assets, edit `esbuild.config.js` to
+# update `publicPath`.
+
 # timezone: America/Los_Angeles
 # pagination:
-#   enabled: true
+#   enabled: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta3
+  version: 1.0.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -431,6 +431,8 @@ files:
 - lib/bridgetown-core/configurations/cypress/cypress_dir/support/commands.js
 - lib/bridgetown-core/configurations/cypress/cypress_dir/support/index.js
 - lib/bridgetown-core/configurations/cypress/cypress_tasks
+- lib/bridgetown-core/configurations/gh-pages.rb
+- lib/bridgetown-core/configurations/gh-pages/gh-pages.yml
 - lib/bridgetown-core/configurations/minitesting.rb
 - lib/bridgetown-core/configurations/netlify.rb
 - lib/bridgetown-core/configurations/netlify/netlify.sh
@@ -605,9 +607,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.4
 signing_key: