feat: Add blog posts section by jcouball · Pull Request #46 · jcouball/notes

jcouball · 2026-03-27T21:16:12Z

Summary

Add a dedicated Blog Posts section to the site with an index page and navigation.

Changes

docs/blog_posts.md — New blog posts index page with a chronological listing of all posts
docs/blog_posts/ — Add 5 blog post files to the new directory:
- Enforcing Conventional Commits with GitHub Actions
- Enforcing Conventional Commits with Git Hooks
- Continuous Delivery for Ruby Gems
- Testing Ruby code that calls abort and exit
- Defining Class Variables and Constants in Anonymous Classes
docs/index.md — Add "Latest Blog Posts" section to the home page
mkdocs.yml — Add Blog Posts navigation section

- Add blog posts index page with chronological listing - Add blog posts to site navigation in mkdocs.yml - Add 'Latest Blog Posts' section to the home page - Include existing blog posts: - Enforcing Conventional Commits with GitHub Actions - Enforcing Conventional Commits with Git Hooks - Continuous Delivery for Ruby Gems - Testing Ruby code that calls abort and exit - Defining Class Variables and Constants in Anonymous Classes

Copilot

Pull request overview

Adds a dedicated Blog Posts area to the MkDocs site, including a posts index and site navigation/homepage entry points for recent posts.

Changes:

Add a Blog Posts navigation section in mkdocs.yml
Add a Latest Blog Posts section to the homepage and a new docs/blog_posts.md index page
Add new blog post documents under docs/blog_posts/

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 13 comments.

Show a summary per file

File	Description
mkdocs.yml	Adds a new “Blog Posts” section to site navigation.
docs/index.md	Adds “Latest Blog Posts” links to the homepage.
docs/blog_posts.md	New blog post index page listing posts chronologically.
docs/blog_posts/2025-04-20-enforcing-conventional-commits-github.md	New (WIP) post stub.
docs/blog_posts/2025-04-18-enforcing-conventional-commits-git.md	New (WIP) post stub with basic outline/TOC.
docs/blog_posts/2025-04-16-continuous-delivery-for-ruby-gems.md	New full post including an implementation runbook and workflow examples.
docs/blog_posts/2024-03-11-testing-ruby-exit-abort.adoc	New post file (currently `.adoc`).
docs/blog_posts/2022-03-21-defining-class-variables-and-constants-in-an-anonymous-class.md	New post content with Ruby examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-27T21:20:49Z

+  - Blog Posts:
+    - blog_posts.md
+    - Defining Class Variables and Constants in an Anonymous Class: blog_posts/2022-03-21-defining-class-variables-and-constants-in-an-anonymous-class.md
+    - Continuous Delivery for Ruby Gems: blog_posts/2025-04-16-continuous-delivery-for-ruby-gems.md
+    - Enforcing Conventional Commits with Git Hooks: blog_posts/2025-04-18-enforcing-conventional-commits-git.md
+    - Enforcing Conventional Commits with GitHub Actions: blog_posts/2025-04-20-enforcing-conventional-commits-github.md


The new Blog Posts nav section omits the 2024-03-11 post that’s linked from both docs/index.md and docs/blog_posts.md. With strict: true, this kind of inconsistency can easily lead to broken/unclear navigation; consider adding the missing post here (or removing the links if it’s intentionally not published).

Copilot · 2026-03-27T21:20:50Z


+### Latest Blog Posts
+
+* 2025-04-21: [Enforcing Conventional Commits with GitHub Actions](blog_posts/2025-04-20-enforcing-conventional-commits-github.md)


The displayed date (2025-04-21) doesn’t match the linked post filename/date (2025-04-20-enforcing-conventional-commits-github.md). This will confuse readers and makes the chronological ordering ambiguous; align the date and the linked file.

Suggested change

* 2025-04-21: [Enforcing Conventional Commits with GitHub Actions](blog_posts/2025-04-20-enforcing-conventional-commits-github.md)

* 2025-04-20: [Enforcing Conventional Commits with GitHub Actions](blog_posts/2025-04-20-enforcing-conventional-commits-github.md)

Copilot · 2026-03-27T21:20:50Z

+* 2025-04-21: [Enforcing Conventional Commits with GitHub Actions](blog_posts/2025-04-20-enforcing-conventional-commits-github.md)
+* 2025-04-18: [Enforcing Conventional Commits with Git Hooks](blog_posts/2025-04-18-enforcing-conventional-commits-git.md)
+* 2025-04-16: [Continuous Delivery for Ruby gems](blog_posts/2025-04-16-continuous-delivery-for-ruby-gems.md)
+* 2024-03-11: [Testing Ruby code that calls `abort` and `exit`](blog_posts/2024-03-11-testing-ruby-exit-abort.adoc)


Linking directly to a .adoc file is likely to render incorrectly in MkDocs (this repo’s mkdocs.yml doesn’t configure an AsciiDoc plugin). Either convert/rename the post to .md and update links, or add/configure an AsciiDoc plugin and include the page in nav so it’s rendered as a proper page.

Suggested change

* 2024-03-11: [Testing Ruby code that calls `abort` and `exit`](blog_posts/2024-03-11-testing-ruby-exit-abort.adoc)

* 2024-03-11: [Testing Ruby code that calls `abort` and `exit`](blog_posts/2024-03-11-testing-ruby-exit-abort.md)

Copilot · 2026-03-27T21:20:50Z

+Using `self` in the method invokation `self.class_variable_set` is redundant.
+I included it in this example to make the point that `class_eval` DOES set
+`self` as expected and that the solution to defining a class variable for
+the anonymous classs is to explicitly call `class_variable_set` in the anonymous


Typo: “classs” should be “class”.

Suggested change

the anonymous classs is to explicitly call `class_variable_set` in the anonymous

the anonymous class is to explicitly call `class_variable_set` in the anonymous

Copilot · 2026-03-27T21:20:50Z

+# Testing Ruby code that calls `abort` and `exit`
+James Couball
+:toc:
+
+Testing code that uses the `abort` or `exit` is a challenge for many developers.


This file is named .adoc, but its content is written in Markdown (e.g., # headings and fenced code blocks). Given MkDocs isn’t configured for AsciiDoc here, this post likely won’t render as intended; consider renaming to .md (and/or converting to real AsciiDoc if that’s the goal).

Copilot · 2026-03-27T21:20:51Z

+* 2025-04-21: [Enforcing Conventional Commits with GitHub Actions](blog_posts/2025-04-20-enforcing-conventional-commits-github.md)
+* 2025-04-18: [Enforcing Conventional Commits with Git Hooks](blog_posts/2025-04-18-enforcing-conventional-commits-git.md)
+* 2025-04-16: [Continuous Delivery for Ruby gems](blog_posts/2025-04-16-continuous-delivery-for-ruby-gems.md)
+* 2024-03-11: [Testing Ruby code that calls `abort` and `exit`](blog_posts/2024-03-11-testing-ruby-exit-abort.adoc)


This index links to a .adoc blog post, but MkDocs in this repo isn’t configured to render AsciiDoc. As a result, the page will likely be served as a static file instead of a rendered doc page; consider renaming/converting it to .md (or adding an AsciiDoc plugin and nav entry).

Suggested change

* 2024-03-11: [Testing Ruby code that calls `abort` and `exit`](blog_posts/2024-03-11-testing-ruby-exit-abort.adoc)

* 2024-03-11: [Testing Ruby code that calls `abort` and `exit`](blog_posts/2024-03-11-testing-ruby-exit-abort.md)

Copilot · 2026-03-27T21:20:51Z

+        name: RubyGems
+        url: https://rubygems.org/gems/<gem-name>
+
+        permissions:
+        contents: write
+        pull-requests: write
+        id-token: write
+
+        steps:
+        - name: Checkout project
+            uses: actions/checkout@v4
+
+        - name: Create release
+            uses: googleapis/release-please-action@v4
+            id: release
+            with:
+            token: ${{ secrets.AUTO_RELEASE_TOKEN }}
+            config-file: release-please-config.json
+            manifest-file: .release-please-manifest.json
+
+        - name: Setup ruby
+            uses: ruby/setup-ruby@v1
+            if: ${{ steps.release.outputs.release_created }}
+            with:
+            bundler-cache: true
+            ruby-version: ruby
+
+        - name: Push to RubyGems.org
+            uses: rubygems/release-gem@v1
+            if: ${{ steps.release.outputs.release_created }}


The GitHub Actions workflow YAML shown here is not valid due to indentation errors (e.g., environment, permissions, and steps children aren’t nested). Since this is a runbook readers may copy/paste, it should be corrected to a valid workflow structure.

Suggested change

name: RubyGems

url: https://rubygems.org/gems/<gem-name>

permissions:

contents: write

pull-requests: write

id-token: write

steps:

- name: Checkout project

uses: actions/checkout@v4

- name: Create release

uses: googleapis/release-please-action@v4

id: release

with:

token: ${{ secrets.AUTO_RELEASE_TOKEN }}

config-file: release-please-config.json

manifest-file: .release-please-manifest.json

- name: Setup ruby

uses: ruby/setup-ruby@v1

if: ${{ steps.release.outputs.release_created }}

with:

bundler-cache: true

ruby-version: ruby

- name: Push to RubyGems.org

uses: rubygems/release-gem@v1

if: ${{ steps.release.outputs.release_created }}

name: RubyGems

url: https://rubygems.org/gems/<gem-name>

permissions:

contents: write

pull-requests: write

id-token: write

steps:

- name: Checkout project

uses: actions/checkout@v4

- name: Create release

uses: googleapis/release-please-action@v4

id: release

with:

token: ${{ secrets.AUTO_RELEASE_TOKEN }}

config-file: release-please-config.json

manifest-file: .release-please-manifest.json

- name: Setup ruby

uses: ruby/setup-ruby@v1

if: ${{ steps.release.outputs.release_created }}

with:

bundler-cache: true

ruby-version: ruby

- name: Push to RubyGems.org

uses: rubygems/release-gem@v1

if: ${{ steps.release.outputs.release_created }}

Copilot · 2026-03-27T21:20:52Z

+# Make it so that calling `rake release` just calls `rake release:rubygems_push` to
+# avoid creating and pushing a new tag.
+
+Rake::Task['release'].clear
+desc 'Customized release task to avoid creating a new tag'
+task release: 'release:rubygem_push'


Within this example, the comment says release:rubygems_push but the task invoked is release:rubygem_push (no “s”). Align these so the runbook doesn’t send readers to a non-existent rake task.

Copilot · 2026-03-27T21:20:52Z

+```Ruby
+class MyClass
+  @@class_var = :foo


Code fences use ```Ruby here, but elsewhere in the docs the repo consistently uses lower-case language identifiers (e.g., ```ruby in docs/ruby/subprocesses.md). Using ruby improves consistency and syntax highlighting reliability.

Copilot · 2026-03-27T21:20:52Z

+end
+```
+
+Using `self` in the method invokation `self.class_variable_set` is redundant.


Typo: “invokation” should be “invocation”.

Suggested change

Using `self` in the method invokation `self.class_variable_set` is redundant.

Using `self` in the method invocation `self.class_variable_set` is redundant.

Copilot AI review requested due to automatic review settings March 27, 2026 21:16

Copilot started reviewing on behalf of jcouball March 27, 2026 21:16 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add blog posts section#46

feat: Add blog posts section#46
jcouball wants to merge 1 commit into
mainfrom
add-blog-posts-section

jcouball commented Mar 27, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Copilot AI Mar 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		### Latest Blog Posts

		* 2025-04-21: [Enforcing Conventional Commits with GitHub Actions](blog_posts/2025-04-20-enforcing-conventional-commits-github.md)

	* 2025-04-21: [Enforcing Conventional Commits with GitHub Actions](blog_posts/2025-04-20-enforcing-conventional-commits-github.md)
	* 2025-04-20: [Enforcing Conventional Commits with GitHub Actions](blog_posts/2025-04-20-enforcing-conventional-commits-github.md)

	* 2024-03-11: [Testing Ruby code that calls `abort` and `exit`](blog_posts/2024-03-11-testing-ruby-exit-abort.adoc)
	* 2024-03-11: [Testing Ruby code that calls `abort` and `exit`](blog_posts/2024-03-11-testing-ruby-exit-abort.md)

	the anonymous classs is to explicitly call `class_variable_set` in the anonymous
	the anonymous class is to explicitly call `class_variable_set` in the anonymous

	Using `self` in the method invokation `self.class_variable_set` is redundant.
	Using `self` in the method invocation `self.class_variable_set` is redundant.

Conversation

jcouball commented Mar 27, 2026

Summary

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants