Merge pull request #22 from genai-musings/trt01

GitHub organization name in URLs.
genai-musings · Sep 1, 2023 · e3525d7 · e3525d7
2 parents 8811a05 + 4f70945
commit e3525d7
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 13 deletions.
diff --git a/.github/config/md-link-check.json b/.github/config/md-link-check.json
@@ -4,7 +4,7 @@
     { "pattern": "/workflows/" },
     { "pattern": "/opensource.org/" },
     { "pattern": "/orgname/reponame/" },
-    { "pattern": "/tom-halpin/" },
+    { "pattern": "/genai-musings/" },
     { "pattern": "/actions?" },
     { "pattern": "assets/" },
     { "pattern": "main/export/" }

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.2] - 2023-09-01
+- [FIXED] GitHub organization name in URLs.
+
 ## [1.5.1] - 2023-08-03
 - [FIXED] Issue with docker image tagging.
 

diff --git a/README.md b/README.md
@@ -3,14 +3,14 @@
 This is a template repository for creating new repositories with pre-configured settings and files commonly used in my Python projects.
 
 [![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
-<!--[![Bandit](https://github.com/tom-halpin/template-repo-template/actions/workflows/bandit.yml/badge.svg)](https://github.com/tom-halpin/template-repo-template/actions/new?category=security)-->
-[![Super-Linter](https://github.com/tom-halpin/template-repo-template/actions/workflows/linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter)
-[![CodeQL](https://github.com/tom-halpin/template-repo-template/workflows/CodeQL/badge.svg?branch=main)
-[![Markdown Links Check](https://github.com/tom-halpin/template-repo-template/actions/workflows/md-links.yml/badge.svg)](https://github.com/gaurav-nelson/github-action-markdown-link-check)
-[![Spell-Checker](https://github.com/tom-halpin/template-repo-template/actions/workflows/spellcheck.yaml/badge.svg)](https://github.com/rojopolis/spellcheck-github-actions)
-[![Unit-Tests](https://github.com/tom-halpin/template-repo-template/actions/workflows/test.yaml/badge.svg)](https://github.com/actions/setup-python)
-[![Code-Coverage](https://github.com/tom-halpin/template-repo-template/actions/workflows/coverage.yaml/badge.svg)](https://github.com/actions/setup-python)
-[![Docker-Build-Push](https://github.com/tom-halpin/template-repo-template/actions/workflows/docker-build-push.yml/badge.svg)](https://hub.docker.com/)
+<!--[![Bandit](https://github.com/genai-musings/template-repo-template/actions/workflows/bandit.yml/badge.svg)](https://github.com/genai-musings/template-repo-template/actions/new?category=security)-->
+[![Super-Linter](https://github.com/genai-musings/template-repo-template/actions/workflows/linter.yml/badge.svg)](https://github.com/marketplace/actions/super-linter)
+[![CodeQL](https://github.com/genai-musings/template-repo-template/workflows/CodeQL/badge.svg?branch=main)
+[![Markdown Links Check](https://github.com/genai-musings/template-repo-template/actions/workflows/md-links.yml/badge.svg)](https://github.com/gaurav-nelson/github-action-markdown-link-check)
+[![Spell-Checker](https://github.com/genai-musings/template-repo-template/actions/workflows/spellcheck.yaml/badge.svg)](https://github.com/rojopolis/spellcheck-github-actions)
+[![Unit-Tests](https://github.com/genai-musings/template-repo-template/actions/workflows/test.yaml/badge.svg)](https://github.com/actions/setup-python)
+[![Code-Coverage](https://github.com/genai-musings/template-repo-template/actions/workflows/coverage.yaml/badge.svg)](https://github.com/actions/setup-python)
+[![Docker-Build-Push](https://github.com/genai-musings/template-repo-template/actions/workflows/docker-build-push.yml/badge.svg)](https://hub.docker.com/)
 
 This is a hello world template repository for creating new python repositories with pre-configured settings and files commonly used in my projects.
 
@@ -108,21 +108,23 @@ The following changes need to be made:
 
 - Update [GitHub issue](https://github.com/orgname/reponame/issues/new) URL in ```CONTRIBUTING.md```.
 
+- Replace ```genai-musings``` GitHub organization name in ```md-link-check.json``` with your GitHub organization name.
+
 - Add any keys / secret files to ```.gitignore```.
 
 - Review and update ```CHANGELOG.md```.
 
 - Review and update ```CODEOWNERS```.
 
-- Enable [CodeQL analysis](https://github.com/tom-halpin/template-repo-template/settings/security_analysis) to identify vulnerabilities and errors with [CodeQL](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql), when enabling select the option to generate - ```.github/codeql.yml```: the GitHub Actions workflow for CodeQL analysis.
+- Enable [CodeQL analysis](https://github.com/genai-musings/template-repo-template/settings/security_analysis) to identify vulnerabilities and errors with [CodeQL](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql), when enabling select the option to generate - ```.github/codeql.yml```: the GitHub Actions workflow for CodeQL analysis.
 
-- Enable [Dependabot](https://github.com/tom-halpin/template-repo-template/settings/security_analysis) alerts, security updates and version updates when enabling it select the option to generate - ```.github/dependabot.yml```: the configuration file controlling how Dependabot maintains the repository. **Note:** Remember to set the ```package-ecosystem`` to pip.
+- Enable [Dependabot](https://github.com/genai-musings/template-repo-template/settings/security_analysis) alerts, security updates and version updates when enabling it select the option to generate - ```.github/dependabot.yml```: the configuration file controlling how Dependabot maintains the repository. **Note:** Remember to set the ```package-ecosystem`` to pip.
 
 - Enable [Bandit](https://github.com/genai-musings/chatting-with-ChatGPT/actions/new?category=security) when enabling it select the option to generate - ```.github/bandit.yml```: the GitHub Actions workflow designed to find common security issues in Python code.
 
-- Enable [Secret Scanning with Push Protection](https://github.com/tom-halpin/template-repo-template/settings/security_analysis) to receive alerts on GitHub for detected secrets, keys, or other tokens, and to block commits which contain supported secrets.
+- Enable [Secret Scanning with Push Protection](https://github.com/genai-musings/template-repo-template/settings/security_analysis) to receive alerts on GitHub for detected secrets, keys, or other tokens, and to block commits which contain supported secrets.
 
-- Add [Branch Protection](https://github.com/tom-halpin/template-repo-template/settings/branches) for the main branch.
+- Add [Branch Protection](https://github.com/genai-musings/template-repo-template/settings/branches) for the main branch.
 
 - Review and if necessary update ```dependabot.yml``` to customize Dependabot alerts.