{"id":46843419,"url":"https://github.com/combostrap/devfiles","last_synced_at":"2026-03-10T14:04:10.847Z","repository":{"id":324270864,"uuid":"1096399604","full_name":"combostrap/devfiles","owner":"combostrap","description":"Combostrap Devfiles - Dev flow configuration across Git repositories.","archived":false,"fork":false,"pushed_at":"2026-02-11T10:14:26.000Z","size":224,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-11T16:57:15.957Z","etag":null,"topics":["devfiles"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/combostrap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-14T11:18:21.000Z","updated_at":"2026-02-11T10:14:30.000Z","dependencies_parsed_at":"2026-02-11T11:09:16.701Z","dependency_job_id":null,"html_url":"https://github.com/combostrap/devfiles","commit_stats":null,"previous_names":["combostrap/repo-shared","combostrap/repo-manager","combostrap/devfiles"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/combostrap/devfiles","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/combostrap%2Fdevfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/combostrap%2Fdevfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/combostrap%2Fdevfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/combostrap%2Fdevfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/combostrap","download_url":"https://codeload.github.com/combostrap/devfiles/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/combostrap%2Fdevfiles/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30336092,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T12:41:07.687Z","status":"ssl_error","status_checked_at":"2026-03-10T12:41:06.728Z","response_time":106,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devfiles"],"created_at":"2026-03-10T14:04:05.833Z","updated_at":"2026-03-10T14:04:10.826Z","avatar_url":"https://github.com/combostrap.png","language":"Jinja","readme":"# Devfiles - Dev flow configuration across Git repositories\n\n## About\n\nThis repository contains [devfiles](#what-are-devfiles).\n\nWe use them to manage centrally and distribute our development flow and environment across Git repositories.\n\n## What are devfiles?\n\n`dotfiles` configure application files, `devfiles` configure a development flow.\n\nWith them, you can:\n\n* init/scaffold a new repo\n* update an existing one to the latest `devfiles`\n\nand get instantly a consistent development environment across your git repositories.\n\n## QuickStart/Install in three commands\n\nIn a new or existing git repository, execute the following commands to install the [devfiles](#what-are-devfiles):\n\n```bash\ncd your-git-repo\ncopier copy https://github.com/combostrap/devfiles .\ndirenv reload\n```\n\nFor a step by step, see [the detailed steps](#steps)\n\n## How it works\n\n### Core Component\n\nIt uses the following core components:\n\n* [copier](#copy-or-update-this-copier-template) for `devfiles` installation and upgrade\n* [direnv](#setup-and-local-configuration-direnv) for setup (project and environment)\n* [dev scripts](#dev-scripts) for development flow\n\n### Utility components\n\nThe utility components are used in the [scripts](#dev-scripts) or as configuration:\n\n* [pre-commit](https://pre-commit.com/) for files check and normalization\n* [jreleaser](#jreleaser ) for release management\n* [pass](#pass---local-secret-management) for secrets management\n* [git-cliff](https://git-cliff.org/) for change log and version bump\n* [go task](#task-distribution) for common tasks distribution\n* [editorconfig](#code-styling-editor-config) for code styling\n* [commitlint](#commit-message-validation-commitlint) for commit message validation\n* [markdown-link-check](#markdown-link-check) for Markdown link validation\n\n## Steps\n\n### Prerequisites\n\nInstall:\n\n* [copier](https://copier.readthedocs.io/en/stable/#installation)\n* [direnv](https://direnv.net/docs/installation.html)\n* [pre-commit](https://pre-commit.com/#install)\n* [task](https://taskfile.dev/docs/installation) `optional`\n\n### Copy or update this copier template\n\n* to install the latest `devfiles` in a git repo (empty or not)\n\n```bash\n# Optionally cd your_repo \u0026\u0026 git init\ncopier copy https://github.com/combostrap/devfiles .\n```\n\n* to update a git repo with the last `devfiles` version\n\n```bash\ncopier update .\n```\n\nNote: the `copier template` is in the [copier-template directory](copier-template)\n\n### Setup and local configuration (direnv)\n\nThe [.envrc](copier-template/.envrc.jinja2) file is the main entry for `setup` and local config.\n\nIt will:\n\n* install the git hooks with [pre-commit](#git-hooks-and-pre-commit)\n* [install the dev scripts](#dev-scripts)\n\nIf you open your terminal, `direnv` should execute `.envrc`.\nIf not:\n\n```bash\ndirenv reload\n```\n\n## Features and configuration\n\n### Pass - Local Secret Management\n\nPass ([pass](https://www.passwordstore.org/) or [gopass](https://www.gopass.pw/)) is used for secret management.\n\nAll secrets are located under the organization name.\n\nExample for a GitHub token:\n\n```bash\npass \"$ORGANIZATION_PATH_NAME/github/release-token\"\n```\n\nNote:\n\n* The secrets are not stored as global shell variables.\n* They are retrieved in wrapper script that wraps a command.\n* They are therefore only available while running the wrapper script.\n\nExample of wrappers:\n\n* [jreleaser](dev-scripts/wrappers/jreleaser)\n* [mvnw (maven)](dev-scripts/package-manager/maven/mvnw)\n\n### JReleaser\n\nFor release management, we use [jreleaser](https://jreleaser.org/).\n\nWe distribute with this template, a [jreleaser](dev-scripts/wrappers/jreleaser) wrapper script\nto pass the needed secrets with [pass](#pass---local-secret-management)\n\n### Git User Configuration\n\nTo set the git user, you can set in your `.bashrc` the following env:\n\n| Env                                     |\n|-----------------------------------------|\n| `DEVF_${ORGANIZATION_NAME}_EMAIL`       |\n| `DEVF_${ORGANIZATION_NAME}_SIGNING_KEY` |\n\nSee the [Git User Configuration Script](dev-scripts/setup/git-config.sh)\n\n### Code Styling (Editor Config)\n\nThe [editorconfig](https://editorconfig.org/) file is [.editorconfig](copier-template/.editorconfig)\n\nWe also use the following `editorconfig` code styling utility:\n\n* [shfmt](https://github.com/mvdan/sh/blob/master/cmd/shfmt/shfmt.1.scd#examples) for bash styling\n* [editorconfig-checker)](https://github.com/editorconfig-checker/editorconfig-checker)\n  as [hook](#git-hooks-and-pre-commit)\n\nNote: Specific for Java, there is also [checkstyle](https://github.com/checkstyle/checkstyle). It's a check tool, not\nintegrated in any IDE.\n\n### Commit Message Validation (CommitLint)\n\n[commitlint](https://commitlint.js.org/) configuration is located\nat [commitlint.config.js](copier-template/.config/commitlint.config.js)\n\n### Markdown Link-Check\n\n[markdown-link-check](https://github.com/tcort/markdown-link-check) for Markdown link validation\nconfiguration is located at [markdown-link-check.config.json](copier-template/.config/markdown-link-check.config.json)\n\n`http` links are checked because only the staged files ar checked\non commit with `pre-commit`.\n\n### Copy .gitignore and .gitattributes if not found\n\nDefault  [.gitignore](copier-template/.gitignore) and [.gitattributes](copier-template/.gitattributes) are installed\n\n### Community/Contribution Documentation\n\n* https://opensource.guide/\n* [List supported by GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types)\n\n#### Create a LICENSE file\n\nA `LICENSE` file is created from the following templates:\n\n* [Apache 2.0](copier-template/%7B%25%20if%20license_type%20==%20'Apache-2.0'%20%25%7DLICENSE%7B%25%20endif%20%25%7D.jinja2)\n* [MIT](copier-template/%7B%25%20if%20license_type%20==%20'MIT'%20%25%7DLICENSE%7B%25%20endif%20%25%7D.jinja2)\n* [FSL](copier-template/%7B%25%20if%20license_type%20==%20'FSL-1.1-ALv2'%20%25%7DLICENSE.md%7B%25%20endif%20%25%7D.jinja2)\n\nWe follow the most common names:\n\n* `LICENSE`,\n* `LICENSE.txt`,\n* `LICENSE.md`\n\n[GitHub Documentation](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)\n\n#### Contributor guidelines\n\nA\nminimal [Contributor guidelines](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)\nfile is created. [CONTRIBUTING.md](copier-template/.github/CONTRIBUTING.md)\n\nThis file is used also to give any direction on how people can start easily with the project.\n\n#### Code of Conduct\n\nA [code of conduct](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)\nis created. [CODE_OF_CONDUCT.md](copier-template/.github/CODE_OF_CONDUCT.md.jinja2)\n\n#### Support Info\n\nA [support documentation](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project)\nis created. [SUPPORT.md](copier-template/.github/SUPPORT.md.jinja2)\n\n#### Attribution / Credit\n\nA default [attribution](https://en.wikipedia.org/wiki/Attribution_(copyright)) file is\ncreated. [ATTRIBUTIONS.md](copier-template/ATTRIBUTIONS.md)\n\n\n#### Security Policy\n\nDefault [Security Policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository):  [SECURITY.md](copier-template/.github/SECURITY.md.jinja2)\n\n#### Issue Template\n\n[Issue forms](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates):\n\n* [01-bug-report.yml](copier-template/.github/ISSUE_TEMPLATE/01-bug-report.yml)\n* [02-feature-request.yml](copier-template/.github/ISSUE_TEMPLATE/02-feature-request.yml)\n\nwith\nthe [Template chooser config file](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser): [config.yml](copier-template/.github/ISSUE_TEMPLATE/config.yml.jinja2)\n\n### Scripts\n\n#### Project only scripts (direnv.d)\n\nFor project only configuration, you can add your own `direnv` scripts in the `PROJECT_ROOT/direnv.d` directory.\nAll `.sh` files present in this directory will be sourced.\n\n#### Dev Scripts\n\nDev scripts located in the [dev-scripts](dev-scripts) directory.\n\nThey are made available:\n\n* by cloning this repository\n* and put in the `PATH`:\n  * the [git-hooks scripts directory](#git-hooks-and-pre-commit)\n  * the [package-manager scripts](dev-scripts/package-manager)\n  * the [setup scripts directory](dev-scripts/setup)\n  * the [wrapper scripts directory](#pass---local-secret-management)\n\nThe code is in the [envrc](copier-template/.envrc.jinja2) and can be configured by setting the\nfollowing variable in your shell profile, `~/.bashrc`, or `~/.config/direnv/direnvrc`, or `~/.envrc.local`.\n\n| Environment                     | Default  Value                         | Description                                                     |\n|---------------------------------|----------------------------------------|-----------------------------------------------------------------|\n| `DEVF_${ORGANIZATION_NAME}_DIR` | `$PROJET_ROOT/../devfiles`             | The local file system location of the devfiles repository clone |\n| `DEVF_${ORGANIZATION_NAME}_URI` | https://github.com/combostrap/devfiles | The URI location of the devfiles repository                     |\n\n#### Scripts Environment variable\n\nIn your scripts, you can use the following env:\n\n| Syntax                   | Description                                                          |\n|--------------------------|----------------------------------------------------------------------|\n| `PROJECT_ID`             | The organization name / project name                                 |\n| `PROJECT_NAME`           | The project name                                                     |\n| `PROJECT_ROOT`           | The root directory of the git repo (ie `GIT_ROOT` without submodule) |\n| `ORGANIZATION_NAME`      | The organization name                                                |\n| `ORGANIZATION_ENV_NAME`  | The organization name in a env format                                |\n| `ORGANIZATION_PATH_NAME` | The organization name in a file path format                          |\n\n### Git Hooks and Pre-commit\n\nThe `pre-commit`:\n\n* config is part of the template at [.pre-commit-config.yaml](copier-template/.pre-commit-config.yaml.jinja2)\n* setup is performed with direnv via [.envrc](copier-template/.envrc.jinja2)\n* extra `git hooks` are available at [git-hooks](dev-scripts/git-hooks)\n\n### Prepare your next commit\n\nYou can check the files in you next commit with:\n\n```bash\ntask prepare\n# equivalent to\ngit add -A \u0026\u0026 pre-commit run\n# or with the common dev script\ngit-prepare\n```\n\n### Task Distribution\n\nThe [go task](https://github.com/go-task/task) file is [Taskfile.yml](copier-template/Taskfile.yml.jinja2)\n\n## How to\n\n### How to update the devfiles to the latest version?\n\nYou can update any repo generated to the last `devfiles` with:\n\n```bash\ntask update\n# or/equivalent to\ncopier update .\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcombostrap%2Fdevfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcombostrap%2Fdevfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcombostrap%2Fdevfiles/lists"}