From 30f5309877a4277a138ed40a5b61954c5d01ec83 Mon Sep 17 00:00:00 2001 From: jcook3701 Date: Mon, 26 Jan 2026 01:32:45 -0800 Subject: [PATCH] Feat 012 (#37) * feat(build): Updates to documentation makefile. * fix(cla): Fix for CLA fix for master branch. --- .github/workflows/cla.yml | 2 +- changelogs/CHANGELOG.md | 14 +++++++++++++- changelogs/releases/v0.1.1.md | 14 +++++++++++++- {{ cookiecutter.project_slug }}/Makefile | 11 +++++++++-- 4 files changed, 36 insertions(+), 5 deletions(-) diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index 4127fc5..dff28e2 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -52,7 +52,7 @@ jobs: path-to-signatures: 'signatures/version1/cla.json' path-to-document: 'https://github.com/{{ github.repository }}/blob/master/docs/jekyll/_site/manual/developer-resources/cla.html' # e.g. a CLA or a DCO document # branch should not be protected - branch: 'main' + branch: 'master' allowlist: "{{ cookiecutter.github_username }},github-actions[bot],dependabot[bot],bot*" # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken diff --git a/changelogs/CHANGELOG.md b/changelogs/CHANGELOG.md index e9a45e3..97a3269 100644 --- a/changelogs/CHANGELOG.md +++ b/changelogs/CHANGELOG.md @@ -91,11 +91,23 @@ Feat 008 cla (#30) - Merge pull request #34 from jcook3701/develop Feat 010 (#33) +- Feat 011 cla fix (#35) + +* fix(docs): jekyll ci/cd fix. + +* fix(cla): Fixed cla path-to-document to not use a template file. +- Merge pull request #36 from jcook3701/develop + +Feat 011 cla fix (#35) ### 🐛 Fixed - *(template)* Updates to template cookiecutter.json file. -- *(docs)* Jekyll ci/cd fix. + +### 🚀 Added + +- *(build)* Updates to documentation makefile. +- *(build)* Updates to documentation makefile. ## [0.1.0] - 2025-12-05 ### ⚙️ Miscellaneous diff --git a/changelogs/releases/v0.1.1.md b/changelogs/releases/v0.1.1.md index 036f205..a30b554 100644 --- a/changelogs/releases/v0.1.1.md +++ b/changelogs/releases/v0.1.1.md @@ -91,8 +91,20 @@ Feat 008 cla (#30) - Merge pull request #34 from jcook3701/develop Feat 010 (#33) +- Feat 011 cla fix (#35) + +* fix(docs): jekyll ci/cd fix. + +* fix(cla): Fixed cla path-to-document to not use a template file. +- Merge pull request #36 from jcook3701/develop + +Feat 011 cla fix (#35) ### 🐛 Fixed - *(template)* Updates to template cookiecutter.json file. -- *(docs)* Jekyll ci/cd fix. + +### 🚀 Added + +- *(build)* Updates to documentation makefile. +- *(build)* Updates to documentation makefile. diff --git a/{{ cookiecutter.project_slug }}/Makefile b/{{ cookiecutter.project_slug }}/Makefile index e5a3949..3c9ecd3 100644 --- a/{{ cookiecutter.project_slug }}/Makefile +++ b/{{ cookiecutter.project_slug }}/Makefile @@ -41,17 +41,23 @@ PUBLISHDIR ?= # -------------------------------------------------- # 📘 Documentation (Sphinx + Jekyll) # -------------------------------------------------- +RUBY_INSTALL := bundle install JEKYLL_BUILD := bundle exec jekyll build --quiet JEKYLL_CLEAN := bundle exec jekyll clean JEKYLL_SERVE := bundle exec jekyll serve # -------------------------------------------------- -.PHONY: all jekyll jekyll-serve build run clean help +.PHONY: all ruby-install jekyll jekyll-serve build run clean help # -------------------------------------------------- # Default: # -------------------------------------------------- all: build # -------------------------------------------------- -# 📘 Documentation (Jekyll) +# ♦️ Ruby +# -------------------------------------------------- +ruby-install: + $(AT)$(RUBY_INSTALL) +# -------------------------------------------------- +# 📚 Documentation (Jekyll) # -------------------------------------------------- jekyll: $(AT)echo "🔨 Building Jekyll site 📘..." @@ -80,6 +86,7 @@ help: $(AT)echo " version: $(PACKAGE_VERSION)" $(AT)echo "" $(AT)echo "Usage:" + $(AT)echo " make ruby-install Installs Gemfile packages." $(AT)echo " make build Generate Jekyll documentation" $(AT)echo " make run Serve Jekyll site locally" $(AT)echo " make clean Clean Jekyll build artifacts"