Initial commit

Author: RedLeader962

.env.template-norlab-project.template

@@ -0,0 +1,35 @@
+# =================================================================================================
+#
+# Set project related environment variables. Those are available for convenience
+#   and are also required by 'norlab-shell-script-tools' library.
+#
+# Usage:
+#
+#   Important! Source this file from 'libnabo' repository root
+#   $ cd <path/to/libnabo/>
+#   $ set -o allexport && source .env.libnabo && set +o allexport
+#
+# =================================================================================================
+
+PROJECT_PROMPT_NAME='Norlab-Project-Template'
+#NBS_SPLASH_NAME=${NBS_SPLASH_NAME:-"${PROJECT_PROMPT_NAME}-build-system"}
+
+# ....Programaticaly fetch source code information.................................................
+PROJECT_GIT_REMOTE_URL=$( git remote get-url origin )
+PROJECT_GIT_NAME=$( basename "${PROJECT_GIT_REMOTE_URL}" .git )
+PROJECT_PATH=$( git rev-parse --show-toplevel )
+PROJECT_SRC_NAME="$( basename ${PROJECT_PATH} )"
+
+# ....Set project related environment variable with their own prefix...............................
+# Note: Those with "PROJECT_" prefix will get eventualy overiden in the case where N2ST is used
+#       as a library. Using generic testing logic require that environment variables with
+#       "PROJECT_" prefix be available.
+PLACEHOLDER_PROMPT_NAME="${PROJECT_PROMPT_NAME}"
+PLACEHOLDER_GIT_REMOTE_URL="${PROJECT_GIT_REMOTE_URL}"
+PLACEHOLDER_GIT_NAME="${PROJECT_GIT_NAME}"
+PLACEHOLDER_PATH="${PROJECT_PATH}"
+PLACEHOLDER_SRC_NAME="${PROJECT_SRC_NAME}"
+
+# ....Set dependencies path........................................................................
+N2ST_PATH=${PROJECT_PATH}/utilities/norlab-shell-script-tools
+#NBS_PATH=${PROJECT_PATH}/utilities/norlab-build-system

.github/CODEOWNERS

@@ -0,0 +1,28 @@
+# =================================================================================================
+# Files or directories with designated code owner.
+#
+# Note:
+#   - Each line is a file pattern followed by one or more owners.
+#   - Branch with branch protection rule "Require review from Code Owners"
+#     will automaticaly trigger a request to a designated code owner
+#
+# Reference: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+#
+# =================================================================================================
+
+# ....Repository wide code owner...................................................................
+# These owners will be the default owners for everything in the repo.
+#*       @RedLeader962
+
+# ....Core directories and files...................................................................
+#/src/ @RedLeader962
+#/tests/ @RedLeader962
+#/README.md @RedLeader962
+#/.env* @RedLeader962
+
+# ....DevOps related...............................................................................
+#/.github/ @RedLeader962
+#/build_system/ @RedLeader962
+#/.gitignore @RedLeader962
+#/.gitmodules @RedLeader962
+#/.dockerignore @RedLeader962

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+# Description
+Add a quick summary here.  
+
+
+
+# Checklist:
+
+### Code related
+- [ ] I have made corresponding changes to the documentation (i.e.: function/class, script header, README.md)
+- [ ] I have commented hard-to-understand code 
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] All tests pass locally with my changes (Check `tests/README.md` for local testing procedure) 
+- [ ] My commit messages follow the [conventional commits](https://www.conventionalcommits.org) specification. See `commit_msg_reference.md` in the repository root for details
+
+### PR creation related 
+- [ ] My pull request `base ref` branch is set to the `dev` branch (the _build-system_ won't be triggered otherwise) 
+- [ ] My pull request branch is up-to-date with the `dev` branch (the _build-system_ will reject it otherwise)
+
+ ## Note for repository admins
+ ### Release PR related
+- Only repository admins have the privilege to `push/merge` on the default branch (ie: `main`) and the `release` branch.
+- Keep PR in `draft` mode until all the release reviewers are ready to push the release. 
+- Once a PR from `release` -> `main` branch is created (not in draft mode), it triggers the _build-system_ test
+- On merge to the `main` branch, it triggers the _semantic-release automation_

.github/workflows/semantic_release.yml

@@ -0,0 +1,65 @@
+#
+# GitHub action for executing "semantic-release" with configuration in ".releaserc.json"
+#
+# Note about pushing to protected branches:
+#
+#   The GITHUB_TOKEN credential does not have the required permission
+#   to operate on protected branches.
+#   Solution:
+#    1. generate a GitHub Personal Access Token
+#    2. and register it as a Repository Secrets and name it `SEMANTIC_RELEASE_GH_TOKEN`
+#    3. Important: set "actions/checkout" to "persist-credentials: false" otherwise it will be overwriten
+#
+# Reference
+#   - https://conventionalcommits.org
+#   - https://semantic-release.gitbook.io
+#   - https://semantic-release.gitbook.io/semantic-release/recipes/ci-configurations/github-actions
+#   - https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
+#
+
+name: Semantic-release
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Semantic-release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "latest"
+      - name: Install semantic-release
+        run: npm install --save-dev semantic-release
+      - name: Install semantic-release additional plugins (git)
+        run: npm install @semantic-release/git
+      - name: Install semantic-release additional plugins (changelog)
+        run: npm install @semantic-release/changelog -D
+      - name: Install semantic-release additional plugins (semantic-release-replace-plugin)
+        run: npm install semantic-release-replace-plugin -D
+      - name: Install semantic-release additional plugins (conventional-changelog-conventionalcommits for commit-analyzer preset)
+        run: npm install conventional-changelog-conventionalcommits -D
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_GH_TOKEN }}
+        run: npx semantic-release
+