Skip to content

Commit

Permalink
chore: fill template skeleton [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
genaumann committed Dec 23, 2023
1 parent 16f5b65 commit 35b51be
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 15 deletions.
8 changes: 4 additions & 4 deletions FORMULA
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: template
name: acme.sh
os: Debian, Ubuntu, Fedora, OpenSuse, Rocky
os_family: Debian, RedHat, Suse
version: 0.0.0
release: 1
minimum_version: 2015.8
summary: Template Formula
description: This is a template
top_level_dir: template
summary: acme.sh formula
description: This formula controls acme.sh
top_level_dir: acme_sh
55 changes: 51 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,54 @@
# Salt Formula Template
# Salt acme.sh Formula

This is a template of Salt Formula.
**:construction_worker: This formula is currently being developed :construction_worker:**

Have a look at my current salt formulas.
## General notes

- [Salt Git Formula](https://github.com/genaumann/salt-git-formula)
See the full [SaltStack Formulas installation and usage instructions][install].

See [`example.yml`](example.yml) on how to configure the formula.

If you want to use this formula, please pay attention to the [`FORMULA`](FORMULA) file and/or `git tag`,
which contains the currently released version.
This formula is versioned according to [Semantic Versioning](http://semver.org/).

## Available states

## Testing

Linux testing is done with `kitchen-salt`.

All tests and lint jobs are executed in GitHub Actions.

### Requirements

You can test the formula locally after installing the following requirements.

- vagrant
- VirtualBox
- Ruby
- bundler

### Run Test

```bash
bundle install
kitchen list # list all available test instances
kitchen test <instance>
```

## OS support matrix

This formula has been tested under the following operating systems and salt versions.

| OS | 3006.5 |
| ------------ | ------ |
| Debian 12 | :x: |
| Ubuntu 22.04 | :x: |
| Rocky 9 | :x: |
| Fedora 38 | :x: |
| OpenSUSE 15 | :x: |

[install]: https://docs.saltproject.io/en/latest/topics/development/conventions/formulas.html
[lint_badge]: https://github.com/genaumann/salt-acme.sh-formula/actions/workflows/lint.yml/badge.svg?branch=main
[test_badge]: https://github.com/genaumann/salt-acme.sh-formula/actions/workflows/salt-kitchen.yml/badge.svg?branch=main
File renamed without changes.
5 changes: 2 additions & 3 deletions kitchen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ suites:
provisioner:
state_top:
base:
"*":
- git
"*": []
pillars_from_files: {}
pillars:
top.sls:
Expand All @@ -45,7 +44,7 @@ provisioner:
log_level: debug
salt_install: none
require_chef: false
formula: git
formula: acme_sh
salt_copy_filter:
- .git/
- .github/
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions test/integration/default/inspec.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
name: default
title: template formula
name: acme.sh
title: acme.sh formula
maintainer: Gino Naumann
version: 0.0.0
licence: Apache-2.0
summary: Template formula
summary: This formula controls acme.sh
supports:
- platform-name: ubuntu
- platform-name: debian
Expand Down

0 comments on commit 35b51be

Please sign in to comment.