refactor: repm to devfiles

Author: gerardnico

.envrc

@@ -60,46 +60,46 @@ fi
 
 
 #################
-# REPM
+# DEVF
 # Bin script installation
 # The installation is done by cloning the repo to a well-known location.
 #################
 echo ""
 echo "Repo manager: "
-export REPM_PREFIX="REPM"
-REPM_DIR_VAR_NAME="${REPM_PREFIX}_${ORGANISATION_ENV_NAME}_DIR"
-export REPM_DIR
-REPM_DIR="${!REPM_DIR_VAR_NAME:-}"
-if [ "$REPM_DIR" != "" ]; then
-  echo "   Repo Directory               : $REPM_DIR (from var $REPM_DIR_VAR_NAME)"
+export DEVF_PREFIX="DEVF"
+DEVF_DIR_VAR_NAME="${DEVF_PREFIX}_${ORGANISATION_ENV_NAME}_DIR"
+export DEVF_DIR
+DEVF_DIR="${!DEVF_DIR_VAR_NAME:-}"
+if [ "$DEVF_DIR" != "" ]; then
+  echo "   Repo Directory               : $DEVF_DIR (from var $DEVF_DIR_VAR_NAME)"
 else
-  REPM_DIR=$(realpath "$PWD/../repo-manager")
-  echo "   Repo Directory               : $REPM_DIR (default)"
+  DEVF_DIR=$(realpath "$PWD/../devfiles")
+  echo "   Repo Directory               : $DEVF_DIR (default)"
 fi
-if [ ! -d "$REPM_DIR" ]; then
+if [ ! -d "$DEVF_DIR" ]; then
 
-    repm_echo_yellow "REPM_DIR ($REPM_DIR) does not exist."
-    REPM_REPO_URI_VAR_NAME="${REPM_PREFIX}_${ORGANISATION_ENV_NAME}_URI"
-    REPM_REPO_URI="${!REPM_REPO_URI_VAR_NAME:-https://github.com/combostrap/repo-manager}"
-    repm_echo_yellow "Clone $REPM_REPO_URI to $REPM_DIR? Y(Yes-Default)/N(No)"
+    repm_echo_yellow "DEVF_DIR ($DEVF_DIR) does not exist."
+    DEVF_REPO_URI_VAR_NAME="${DEVF_PREFIX}_${ORGANISATION_ENV_NAME}_URI"
+    DEVF_REPO_URI="${!DEVF_REPO_URI_VAR_NAME:-https://github.com/combostrap/devfiles}"
+    repm_echo_yellow "Clone $DEVF_REPO_URI to $DEVF_DIR? Y(Yes-Default)/N(No)"
     read -r CLONE
     if [ "$CLONE" == "" ] || [ "$CLONE" == "Y" ]; then
-        git clone "$REPM_REPO_URI" "$REPM_DIR"
+        git clone "$DEVF_REPO_URI" "$DEVF_DIR"
         repm_echo_yellow "Repo Manager repo cloned"
     fi
 
 fi
 
 # Exit if the repo was not installed
-if [ -d "$REPM_DIR" ]; then
+if [ -d "$DEVF_DIR" ]; then
 
     #################
     # Bin
     #################
-    BIN_PATH="$REPM_DIR/bin"
+    BIN_PATH="$DEVF_DIR/bin"
     export PATH="$BIN_PATH:$PATH" # bin path first as it has a higher priority
     echo "   Common Scripts Path          : $BIN_PATH"
-    BIN_PACKAGE_MANAGER_PATH="$REPM_DIR/bin/package-manager/none"
+    BIN_PACKAGE_MANAGER_PATH="$DEVF_DIR/bin/package-manager/none"
     export PATH="$BIN_PACKAGE_MANAGER_PATH:$PATH" # bin path first as it has a higher priority
     echo "   Package Manager Scripts Path : $BIN_PACKAGE_MANAGER_PATH"
 
@@ -135,7 +135,7 @@ echo ""
 echo "Env: "
 echo "   PROJECT_ROOT      : $PROJECT_ROOT"
 echo "   ORGANISATION_NAME : $ORGANISATION_NAME"
-echo "   REPM_DIR          : $REPM_DIR"
+echo "   DEVF_DIR          : $DEVF_DIR"
 
 # Last EOL before direnv output
 echo ""

.pre-commit-config.yaml

@@ -35,7 +35,7 @@ repos:
         stages: [ commit-msg ]
         additional_dependencies: [ '@commitlint/config-conventional' ]
         args: [ "--verbose" , "--config", ".config/commitlint.config.js" ]
-  - repo: https://github.com/combostrap/repo-manager
+  - repo: https://github.com/combostrap/devfiles
     rev: v0.1.0
     hooks:
       - id: prevent-out-of-sync-commit

README.md

@@ -1,26 +1,49 @@
-# Repo Manager (repm): Dynamic Repository Management
+# Combostrap Dev files - development flow
 
 ## About
 
-This repository helps to init and update git combostrap repositories.
+This repository contains `devfiles`.
 
-## Concept / How it works
+`dotfiles` configure application files, `devfiles` configure a development flow.
 
-It uses the following software to manage common repositories stuff:
+With them, you can:
+* init a new repo
+* update an existing one
+and get instantly a consistent development environment across git repositories.
+
+
+## QuickStart in three commands
+
+```bash
+cd your-git-repo
+copier copy https://github.com/combostrap/devfiles .
+direnv reload
+```
+
+For a step by step, see [the detailed steps](#steps)
+
+## How it works
+
+### Core Component
+
+It uses the following core components to manage common repositories stuff:
 
 * [copier](https://copier.readthedocs.io/) for project templating and upgrade
-* [direnv](https://direnv.net/) for project setup and environment
-* [pre-commit](https://pre-commit.com/) for files check and normalization
-* [common scripts](#common-scripts)  are made available by cloning this repo and putting them in the `PATH`.
+* [direnv](https://direnv.net/) for setup (project and environment)
+* [dev scripts](#dev-scripts) for development flow
+
+### Utility components
 
-## Where are the artifacts
+The utility components are used in the scripts or as configuration:
 
-* The `copier` template is located at [copier template](copier-template)
-* The `pre-commit`
-  * config is part of the template at [.pre-commit-config.yaml](copier-template/.pre-commit-config.yaml)
-  * setup is performed with direnv via [.envrc](copier-template/.envrc.jinja)
-  * extra `git hooks` are available at [git-hooks](git-hooks)
-* The common dev scripts are in the [bin](bin)
+* [pre-commit](https://pre-commit.com/) for files check and normalization
+* [jreleaser](#jreleaser ) for release management
+* [pass](#pass---local-secret-management) for secrets management
+* [git-cliff](https://git-cliff.org/) for change log and version bump
+* [go task](#task-distribution) for common tasks distribution
+* [editorconfig](#code-styling-editor-config) for code styling
+* [commitlint](#commit-message-validation-commitlint) for commit message validation
+* [markdown-link-check](#markdown-link-check) for Markdown link validation
 
 ## Steps
 
@@ -35,15 +58,14 @@ Install:
 
 ### Copy or update this copier template
 
-* for a new git repo
+* to install the latest `devfiles` in a git repo (empty or not)
 
 ```bash
-# Optionally
-# cd your_repo && git init
-copier copy https://github.com/combostrap/repo-manager .
+# Optionally cd your_repo && git init
+copier copy https://github.com/combostrap/devfiles .
 ```
 
-* to update a git repo
+* to update a git repo with the last `devfiles` version
 
 ```bash
 copier update .
@@ -55,8 +77,8 @@ The [.envrc](copier-template/.envrc.jinja) file is the main entry for `setup` an
 
 It will:
 
-* install the git hooks with `pre-commit`
-* [install the common scripts](#common-scripts)
+* install the git hooks with [pre-commit](#git-hooks-and-pre-commit)
+* [install the common scripts](#dev-scripts)
 
 If you open your terminal, `direnv` should execute `.envrc`.
 If not:
@@ -67,20 +89,61 @@ direnv reload
 
 ## Features and configuration
 
+### Copier Template
+
+The `copier` template is located at [copier template](copier-template)
+
+### Pass - Local Secret Management
+
+Pass ([pass](https://www.passwordstore.org/) or [gopass](https://www.gopass.pw/)) is used for secret management.
+
+All secrets are located under the organization name.
+
+Example for a GitHub token:
+
+```bash
+pass "$ORGANISATION_PATH_NAME/github/release-token"
+```
+
+The secrets are not stored as global shell variables.
+We create wrapper scripts so that the secret is only available while running the script.
+
+Example of wrappers:
+
+* [jreleaser](dev-scripts/common/jreleaser)
+* [mvnw (maven)](dev-scripts/package-manager/maven/mvnw)
+
+### JReleaser
+
+For release management, we use [jreleaser](https://jreleaser.org/).
+
+We distribute with this template, a [jreleaser](dev-scripts/common/jreleaser) wrapper script
+to pass the needed secrets with [pass](#pass---local-secret-management)
+
 ### Git User Configuration
 
 To set the git user, you can set in your `.bashrc` the following env:
 
 | Env                                     |
 |-----------------------------------------|
-| `REPM_${ORGANIZATION_NAME}_EMAIL`       |
-| `REPM_${ORGANIZATION_NAME}_SIGNING_KEY` |
+| `DEVF_${ORGANIZATION_NAME}_EMAIL`       |
+| `DEVF_${ORGANIZATION_NAME}_SIGNING_KEY` |
+
+See the [Git User Configuration Script](dev-scripts/common/git-config-user)
 
-See the [Git User Configuration Script](bin/git-config-user)
+### Code Styling (Editor Config)
 
-### Editor Config for code styling
+The [editorconfig](https://editorconfig.org/) file is [.editorconfig](copier-template/.editorconfig)
 
-Install the [root editor config](copier-template/.editorconfig)
+### Commit Message Validation (CommitLint)
+
+[commitlint](https://commitlint.js.org/) configuration is located
+at [commitlint.config.js](copier-template/.config/commitlint.config.js)
+
+### Markdown Link-Check
+
+[markdown-link-check](https://github.com/tcort/markdown-link-check) for Markdown link validation
+configuration is located at [markdown-link-check.config.json](copier-template/.config/markdown-link-check.config.json)
 
 ### Copy .gitignore and .gitattributes if not found
 
@@ -97,20 +160,24 @@ A License is installed
 For project only configuration, you can add your own `direnv` scripts in the `PROJECT_ROOT/direnv.d` directory.
 All `.sh` files present in this directory will be sourced.
 
-#### Common Scripts
+#### Dev Scripts
 
-Common scripts located in the [bin](bin) directory are made available:
+Dev scripts located in the [dev-scripts](dev-scripts) directory.
+
+They are made available:
 
 * by cloning this repo
-* and put the [bin](bin) in the `PATH`
+* and put in the PATH:
+  * the [common-scripts directory](dev-scripts/common)
+  * the [package-manager directory](dev-scripts/package-manager)
 
 The code is in the [envrc](copier-template/.envrc.jinja) and can be configured by setting the
 following variable in your shell profile, `~/.bashrc`, or `~/.config/direnv/direnvrc`, or `~/.envrc.local`.
 
-| Environment                     | Default  Value                             | Description                                                             |
-|---------------------------------|--------------------------------------------|-------------------------------------------------------------------------|
-| `REPM_${ORGANIZATION_NAME}_DIR` | `$PROJET_ROOT/../repo-manager`             | The local file system location of the resource manager repository clone |
-| `REPM_${ORGANIZATION_NAME}_URI` | https://github.com/combostrap/repo-manager | The URI location of the resource manager repository                     |
+| Environment                     | Default  Value                         | Description                                                     |
+|---------------------------------|----------------------------------------|-----------------------------------------------------------------|
+| `DEVF_${ORGANIZATION_NAME}_DIR` | `$PROJET_ROOT/../devfiles`             | The local file system location of the devfiles repository clone |
+| `DEVF_${ORGANIZATION_NAME}_URI` | https://github.com/combostrap/devfiles | The URI location of the devfiles repository                     |
 
 #### Scripts Environment variable
 
@@ -123,6 +190,14 @@ In your scripts, you can use the following env:
 | `ORGANISATION_ENV_NAME`  | The organization name in a env format                                |
 | `ORGANISATION_PATH_NAME` | The organization name in a file path format                          |
 
+### Git Hooks and Pre-commit
+
+The `pre-commit`:
+
+* config is part of the template at [.pre-commit-config.yaml](copier-template/.pre-commit-config.yaml)
+* setup is performed with direnv via [.envrc](copier-template/.envrc.jinja)
+* extra `git hooks` are available at [git-hooks](git-hooks)
+
 ### Prepare your next commit
 
 You can check the files in you next commit with:
@@ -144,3 +219,7 @@ task update
 # equivalent to
 copier update .
 ```
+
+### Task Distribution
+
+The [go task](https://github.com/go-task/task) file is [Taskfile.yaml](copier-template/Taskfile.yaml)

…mplate/.config/markdown-lint-config.json …/.config/markdown-link-check.config.jsoncopier-template/.config/markdown-lint-config.json renamed to copier-template/.config/markdown-link-check.config.json copier-template/.config/markdown-lint-config.json renamed to copier-template/.config/markdown-link-check.config.json

@@ -60,48 +60,49 @@ fi
 
 
 #################
-# REPM
+# DEVF
 # Bin script installation
 # The installation is done by cloning the repo to a well-known location.
 #################
 echo ""
 echo "Repo manager: "
-export REPM_PREFIX="REPM"
-REPM_DIR_VAR_NAME="${REPM_PREFIX}_${ORGANISATION_ENV_NAME}_DIR"
-export REPM_DIR
-REPM_DIR="${!REPM_DIR_VAR_NAME:-}"
-if [ "$REPM_DIR" != "" ]; then
-  echo "   Repo Directory               : $REPM_DIR (from var $REPM_DIR_VAR_NAME)"
+export DEVF_PREFIX="DEVF"
+DEVF_DIR_VAR_NAME="${DEVF_PREFIX}_${ORGANISATION_ENV_NAME}_DIR"
+export DEVF_DIR
+DEVF_DIR="${!DEVF_DIR_VAR_NAME:-}"
+if [ "$DEVF_DIR" != "" ]; then
+  echo "   Repo Directory               : $DEVF_DIR (from var $DEVF_DIR_VAR_NAME)"
 else
-  REPM_DIR=$(realpath "$PWD/../repo-manager")
-  echo "   Repo Directory               : $REPM_DIR (default)"
+  DEVF_DIR=$(realpath "$PWD/../devfiles")
+  echo "   Repo Directory               : $DEVF_DIR (default)"
 fi
-if [ ! -d "$REPM_DIR" ]; then
+if [ ! -d "$DEVF_DIR" ]; then
 
-    repm_echo_yellow "REPM_DIR ($REPM_DIR) does not exist."
-    REPM_REPO_URI_VAR_NAME="${REPM_PREFIX}_${ORGANISATION_ENV_NAME}_URI"
-    REPM_REPO_URI="${!REPM_REPO_URI_VAR_NAME:-https://github.com/combostrap/repo-manager}"
-    repm_echo_yellow "Clone $REPM_REPO_URI to $REPM_DIR? Y(Yes-Default)/N(No)"
+    repm_echo_yellow "DEVF_DIR ($DEVF_DIR) does not exist."
+    DEVF_REPO_URI_VAR_NAME="${DEVF_PREFIX}_${ORGANISATION_ENV_NAME}_URI"
+    DEVF_REPO_URI="${!DEVF_REPO_URI_VAR_NAME:-https://github.com/combostrap/devfiles}"
+    repm_echo_yellow "Clone $DEVF_REPO_URI to $DEVF_DIR? Y(Yes-Default)/N(No)"
     read -r CLONE
     if [ "$CLONE" == "" ] || [ "$CLONE" == "Y" ]; then
-        git clone "$REPM_REPO_URI" "$REPM_DIR"
+        git clone "$DEVF_REPO_URI" "$DEVF_DIR"
         repm_echo_yellow "Repo Manager repo cloned"
     fi
 
 fi
 
 # Exit if the repo was not installed
-if [ -d "$REPM_DIR" ]; then
+if [ -d "$DEVF_DIR" ]; then
 
     #################
     # Bin
     #################
-    BIN_PATH="$REPM_DIR/bin"
-    export PATH="$BIN_PATH:$PATH" # bin path first as it has a higher priority
-    echo "   Common Scripts Path          : $BIN_PATH"
-    BIN_PACKAGE_MANAGER_PATH="$REPM_DIR/bin/package-manager/{{ package_manager }}"
-    export PATH="$BIN_PACKAGE_MANAGER_PATH:$PATH" # bin path first as it has a higher priority
-    echo "   Package Manager Scripts Path : $BIN_PACKAGE_MANAGER_PATH"
+    DEV_SCRIPT_PATH="$DEVF_DIR/dev-scripts"
+    COMMON_SCRIPT_PATH="$DEV_SCRIPT_PATH/common"
+    export PATH="$COMMON_SCRIPT_PATH:$PATH" # script path first as it has a higher priority
+    echo "   Common Scripts Path          : $COMMON_SCRIPT_PATH"
+    PACKAGE_MANAGER_PATH="$DEV_SCRIPT_PATH/package-manager/{{ package_manager }}"
+    export PATH="$PACKAGE_MANAGER_PATH:$PATH" # script path first as it has a higher priority
+    echo "   Package Manager Scripts Path : $PACKAGE_MANAGER_PATH"
 
     echo ""
     echo "Git: "
@@ -135,7 +136,7 @@ echo ""
 echo "Env: "
 echo "   PROJECT_ROOT      : $PROJECT_ROOT"
 echo "   ORGANISATION_NAME : $ORGANISATION_NAME"
-echo "   REPM_DIR          : $REPM_DIR"
+echo "   DEVF_DIR          : $DEVF_DIR"
 
 # Last EOL before direnv output
 echo ""

copier-template/.envrc.jinja

@@ -24,7 +24,7 @@ repos:
     hooks:
       - id: markdown-link-check
         name: markdown link check
-        args: [ --quiet, "--config", ".config/markdown-lint-config.json" ]
+        args: [ --quiet, "--config", ".config/markdown-link-check.config.json" ]
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
     rev: e46582c # v9.23.0
     hooks:
@@ -35,7 +35,7 @@ repos:
         stages: [ commit-msg ]
         additional_dependencies: [ '@commitlint/config-conventional' ]
         args: [ "--verbose" , "--config", ".config/commitlint.config.js" ]
-  - repo: https://github.com/combostrap/repo-manager
+  - repo: https://github.com/combostrap/devfiles
     rev: v0.1.0
     hooks:
       - id: prevent-out-of-sync-commit