Website publishing improvements

defmethodinc / just-not-sorry

Chrome extension that warns you when you write emails using words which undermine your message

https://justnotsorry.com/

Other

243 stars 37 forks source link

Website publishing improvements #165

Closed sbrudz closed 1 year ago

sbrudz commented 1 year ago

This PR improves the publishing process for https://justnotsorry.com with the goal of making website updates easier and clearer.

Changes include:

[x] Moved all the jekyll site generator code from the gh-pages branch into the site subdirectory
[x] Configured gh-pages npm package to deploy the site subdirectory to the gh-pages branch
[x] Configured a GitHub actions workflow that will trigger a site deployment when relevant files change
[x] Added Dynamic generation of the "List of Warning Phrases" page content based on phrases.json
[x] Added a git commit SHA and publication timestamp to the footer of justnotsorry.com
[x] Updated ReadMe files to describe new process

jduffy3 commented 1 year ago

Had an issue running bundle install locally on my machine:

An error occurred while installing eventmachine (1.2.7), and Bundler cannot continue.

In Gemfile:
  github-pages was resolved to 219, which depends on
    jekyll-avatar was resolved to 0.7.0, which depends on
      jekyll was resolved to 3.9.0, which depends on
        em-websocket was resolved to 0.5.3, which depends on
          eventmachine

but was able to resolve it with this

https://stackoverflow.com/questions/74196882/cannot-install-jekyll-eventmachine-on-m1-mac

sbrudz commented 1 year ago

Had an issue running bundle install locally on my machine:
An error occurred while installing eventmachine (1.2.7), and Bundler cannot continue.

In Gemfile:
  github-pages was resolved to 219, which depends on
    jekyll-avatar was resolved to 0.7.0, which depends on
      jekyll was resolved to 3.9.0, which depends on
        em-websocket was resolved to 0.5.3, which depends on
          eventmachine
but was able to resolve it with this

https://stackoverflow.com/questions/74196882/cannot-install-jekyll-eventmachine-on-m1-mac

What version of ruby and openssl were you using? I wonder if I should upgrade to ruby 3 since 2.7's EOL is in March.

jduffy3 commented 1 year ago

➜  just-not-sorry git:(website-publishing-improvements) ✗ openssl version
LibreSSL 3.3.6

I had to install 2.7 with rvm to start the bundle install

➜  site git:(website-publishing-improvements) ✗ ruby -v
ruby 2.7.5p203 (2021-11-24 revision f69aeb8314) [arm64-darwin22]

However I noticed that locally this updated site/Gemfile.lock locally for me with the following PLATFORM: arm64-darwin-22

sbrudz commented 1 year ago

I create a new issue for the ruby upgrade: https://github.com/defmethodinc/just-not-sorry/issues/171

sbrudz commented 1 year ago

However I noticed that locally this updated site/Gemfile.lock locally for me with the following PLATFORM: arm64-darwin-22

This seems to be fine as the PLATFORM gets updated when bundle install is run on a new platform (per this article). I'll bet you're on OS 13. I'm still on 12.

jduffy3 commented 1 year ago

However I noticed that locally this updated site/Gemfile.lock locally for me with the following PLATFORM: arm64-darwin-22

This seems to be fine as the PLATFORM gets updated when bundle install is run on a new platform (per this article). I'll bet you're on OS 13. I'm still on 12.

Yup I'm on 13!

sbrudz commented 1 year ago

@jduffy3 I added a job to the justnotsorry.com GitHub Action workflow that will run bundle install and perform a test build of the site. It'll only publish once the changes are on the main branch. This should help catch potential issues with the ruby/jekyll configuration during the PR stage.

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 2.5.1 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: