{"id":19871873,"url":"https://github.com/saltstack-formulas/template-formula","last_synced_at":"2026-01-25T08:31:03.201Z","repository":{"id":11599040,"uuid":"14091038","full_name":"saltstack-formulas/template-formula","owner":"saltstack-formulas","description":"SaltStack formula template filled with dummy content","archived":false,"fork":false,"pushed_at":"2026-01-22T17:24:12.000Z","size":1487,"stargazers_count":123,"open_issues_count":36,"forks_count":85,"subscribers_count":34,"default_branch":"master","last_synced_at":"2026-01-23T10:31:33.104Z","etag":null,"topics":["salt-formula","saltstack-formula","template"],"latest_commit_sha":null,"homepage":"http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saltstack-formulas.png","metadata":{"files":{"readme":"docs/README.rst","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING_DOCS.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2013-11-03T18:51:52.000Z","updated_at":"2026-01-22T11:54:52.000Z","dependencies_parsed_at":"2023-10-03T15:04:04.957Z","dependency_job_id":"ffdfeba1-d009-443b-abb7-8af92f76dd99","html_url":"https://github.com/saltstack-formulas/template-formula","commit_stats":null,"previous_names":[],"tags_count":142,"template":true,"template_full_name":null,"purl":"pkg:github/saltstack-formulas/template-formula","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Ftemplate-formula","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Ftemplate-formula/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Ftemplate-formula/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Ftemplate-formula/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack-formulas","download_url":"https://codeload.github.com/saltstack-formulas/template-formula/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack-formulas%2Ftemplate-formula/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28749284,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T07:58:02.558Z","status":"ssl_error","status_checked_at":"2026-01-25T07:57:57.153Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["salt-formula","saltstack-formula","template"],"created_at":"2024-11-12T16:13:51.780Z","updated_at":"2026-01-25T08:31:03.178Z","avatar_url":"https://github.com/saltstack-formulas.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":".. _readme:\n\nTEMPLATE-formula\n================\n\n|img_travis| |img_sr| |img_pc|\n\n.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/TEMPLATE-formula.svg?branch=master\n   :alt: Travis CI Build Status\n   :scale: 100%\n   :target: https://travis-ci.com/saltstack-formulas/TEMPLATE-formula\n.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :alt: Semantic Release\n   :scale: 100%\n   :target: https://github.com/semantic-release/semantic-release\n.. |img_pc| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\n   :alt: pre-commit\n   :scale: 100%\n   :target: https://github.com/pre-commit/pre-commit\n\nA SaltStack formula that is empty. It has dummy content to help with a quick\nstart on a new formula and it serves as a style guide.\n\n.. contents:: **Table of Contents**\n   :depth: 1\n\nGeneral notes\n-------------\n\nSee the full `SaltStack Formulas installation and usage instructions\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html\u003e`_.\n\nIf you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section\n\u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas\u003e`_.\n\nIf you want to use this formula, please pay attention to the ``FORMULA`` file and/or ``git tag``,\nwhich contains the currently released version. This formula is versioned according to `Semantic Versioning \u003chttp://semver.org/\u003e`_.\n\nSee `Formula Versioning Section \u003chttps://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning\u003e`_ for more details.\n\nIf you need (non-default) configuration, please refer to:\n\n- `how to configure the formula with map.jinja \u003cmap.jinja.rst\u003e`_\n- the ``pillar.example`` file\n- the `Special notes`_ section\n\nContributing to this repo\n-------------------------\n\nCommit messages\n^^^^^^^^^^^^^^^\n\n**Commit message formatting is significant!!**\n\nPlease see `How to contribute \u003chttps://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst\u003e`_ for more details.\n\npre-commit\n^^^^^^^^^^\n\n`pre-commit \u003chttps://pre-commit.com/\u003e`_ is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.\nFirst install  the ``pre-commit`` package manager using the appropriate `method \u003chttps://pre-commit.com/#installation\u003e`_, then run ``bin/install-hooks`` and\nnow ``pre-commit`` will run automatically on each ``git commit``. ::\n\n  $ bin/install-hooks\n  pre-commit installed at .git/hooks/pre-commit\n  pre-commit installed at .git/hooks/commit-msg\n\nSpecial notes\n-------------\n\n.. \u003cREMOVEME\n\nUsing this template\n^^^^^^^^^^^^^^^^^^^\n\nThe easiest way to use this template formula as a base for a new formula is to use GitHub's **Use this template** button to create a new repository. For consistency with the rest of the formula ecosystem, name your formula repository following the pattern ``\u003cformula theme\u003e-formula``, where ``\u003cformula theme\u003e`` consists of lower-case alphabetic characters, numbers, '-' or '_'.\n\nIn the rest of this example we'll use ``example`` as the ``\u003cformula theme\u003e``.\n\nFollow these steps to complete the conversion from ``template-formula`` to ``example-formula``. ::\n\n  $ git clone git@github.com:YOUR-USERNAME/example-formula.git\n  $ cd example-formula/\n  $ bin/convert-formula.sh example\n  $ git push --force\n\nAlternatively, it's possible to clone ``template-formula`` into a new repository and perform the conversion there. For example::\n\n  $ git clone https://github.com/saltstack-formulas/template-formula example-formula\n  $ cd example-formula/\n  $ bin/convert-formula.sh example\n\nTo take advantage of `semantic-release \u003chttps://github.com/semantic-release/semantic-release\u003e`_ for automated changelog generation and release tagging, you will need a GitHub `Personal Access Token \u003chttps://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line\u003e`_ with at least the **public_repo** scope.\n\nIn the Travis repository settings for your new repository, create an `environment variable \u003chttps://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings\u003e`_ named ``GH_TOKEN`` with the personal access token as value, restricted to the ``master`` branch for security.\n\nNote that this repository uses a `CODEOWNERS \u003chttps://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners\u003e`_ file to assign ownership to various parts of the formula. The conversion process removes overall ownership, but you should consider assigning ownership to yourself or your organisation when contributing your new formula to the ``saltstack-formulas`` organisation.\n\n.. REMOVEME\u003e\n\nAvailable states\n----------------\n\n.. contents::\n   :local:\n\n``TEMPLATE``\n^^^^^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nThis installs the TEMPLATE package,\nmanages the TEMPLATE configuration file and then\nstarts the associated TEMPLATE service.\n\n``TEMPLATE.package``\n^^^^^^^^^^^^^^^^^^^^\n\nThis state will install the TEMPLATE package only.\n\n``TEMPLATE.config``\n^^^^^^^^^^^^^^^^^^^\n\nThis state will configure the TEMPLATE service and has a dependency on ``TEMPLATE.install``\nvia include list.\n\n``TEMPLATE.service``\n^^^^^^^^^^^^^^^^^^^^\n\nThis state will start the TEMPLATE service and has a dependency on ``TEMPLATE.config``\nvia include list.\n\n``TEMPLATE.clean``\n^^^^^^^^^^^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nthis state will undo everything performed in the ``TEMPLATE`` meta-state in reverse order, i.e.\nstops the service,\nremoves the configuration file and\nthen uninstalls the package.\n\n``TEMPLATE.service.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will stop the TEMPLATE service and disable it at boot time.\n\n``TEMPLATE.config.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will remove the configuration of the TEMPLATE service and has a\ndependency on ``TEMPLATE.service.clean`` via include list.\n\n``TEMPLATE.package.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will remove the TEMPLATE package and has a depency on\n``TEMPLATE.config.clean`` via include list.\n\n``TEMPLATE.subcomponent``\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\n*Meta-state (This is a state that includes other states)*.\n\nThis state installs a subcomponent configuration file before\nconfiguring and starting the TEMPLATE service.\n\n``TEMPLATE.subcomponent.config``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will configure the TEMPLATE subcomponent and has a\ndependency on ``TEMPLATE.config`` via include list.\n\n``TEMPLATE.subcomponent.config.clean``\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis state will remove the configuration of the TEMPLATE subcomponent\nand reload the TEMPLATE service by a dependency on\n``TEMPLATE.service.running`` via include list and ``watch_in``\nrequisite.\n\nTesting\n-------\n\nLinux testing is done with ``kitchen-salt``.\n\nRequirements\n^^^^^^^^^^^^\n\n* Ruby\n* Docker\n\n.. code-block:: bash\n\n   $ gem install bundler\n   $ bundle install\n   $ bin/kitchen test [platform]\n\nWhere ``[platform]`` is the platform name defined in ``kitchen.yml``,\ne.g. ``debian-9-2019-2-py3``.\n\n``bin/kitchen converge``\n^^^^^^^^^^^^^^^^^^^^^^^^\n\nCreates the docker instance and runs the ``TEMPLATE`` main state, ready for testing.\n\n``bin/kitchen verify``\n^^^^^^^^^^^^^^^^^^^^^^\n\nRuns the ``inspec`` tests on the actual instance.\n\n``bin/kitchen destroy``\n^^^^^^^^^^^^^^^^^^^^^^^\n\nRemoves the docker instance.\n\n``bin/kitchen test``\n^^^^^^^^^^^^^^^^^^^^\n\nRuns all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.\n\n``bin/kitchen login``\n^^^^^^^^^^^^^^^^^^^^^\n\nGives you SSH access to the instance for manual testing.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Ftemplate-formula","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack-formulas%2Ftemplate-formula","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack-formulas%2Ftemplate-formula/lists"}