Merge pull request #1 from genaumann/initial

Initial repo and software setup

.github/workflows/salt-kitchen.yml

@@ -16,19 +16,19 @@ jobs:
           - default-debian-12-30065
           - default-rocky9-30065
           - default-fedora38-30065
-          - default-opensuse15-30065
+          - default-opensuse15-30060
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.2"
+          ruby-version: "3.2.2"
           bundler-cache: true
       - name: Install vagrant and virtualbox
         uses: ConorMacBride/install-package@v1
         with:
           apt: vagrant virtualbox
       - name: Run kitchen test
         run: |
-          bundle exec kitchen test ${{ matrix.instances }}
+          CRED="export HETZNER_TOKEN=${{ secrets.HETZNER_TOKEN }}" bundle exec kitchen test ${{ matrix.instances }}

.gitignore

@@ -0,0 +1,4 @@
+.venv/
+.kitchen/
+.vagrant/
+Vagrantfile

.releaserc.yml

@@ -27,7 +27,7 @@ plugins:
         - type: test
           release: patch
         - type: ci
-          release: patch
+          release: false
         - type: build
           release: patch
 

README.md

@@ -1,6 +1,20 @@
 # Salt acme.sh Formula
 
-**:construction_worker: This formula is currently being developed :construction_worker:**
+![GitHub release](https://img.shields.io/github/v/release/genaumann/salt-acme.sh-formula)
+![lint][lint_badge]
+![test][test_badge]
+
+Interacts with [acme.sh](https://acme.sh):
+
+- install acme.sh
+- issue certificates
+- renew certificates
+
+The following modes are supported:
+
+- standalone
+- webroot
+- dns
 
 ## General notes
 
@@ -14,6 +28,33 @@ This formula is versioned according to [Semantic Versioning](http://semver.org/)
 
 ## Available states
 
+- [`acme.sh`](acme.sh/init.sls)
+- [`acme.sh.install`](acme.sh/install.sls)
+- [`acme.sh.issue`](acme.sh/issue.sls)
+
+### `acme.sh`
+
+Includes the following states:
+
+- `acme.sh.install`
+- `acme.sh.issue`
+
+### `acme.sh.install`
+
+Installs `acme.sh`.
+
+### `acme.sh.issue`
+
+Issues or renews certificate with `acme.sh`.
+
+## Available execution modules
+
+- [`acme.sh`](docs/module_acme_sh.md)
+
+## Available state modules
+
+- [`acme.sh`](docs/state_acme_sh.md)
+
 ## Testing
 
 Linux testing is done with `kitchen-salt`.
@@ -41,13 +82,13 @@ kitchen test <instance>
 
 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:    |
+| OS           | 3006.0 | 3006.5       |
+| ------------ | ------ | ------------ |
+| Debian 12    | :x:    | ✅           |
+| Ubuntu 22.04 | :x:    | ✅           |
+| Rocky 9      | :x:    | ✅           |
+| Fedora 38    | :x:    | ✅           |
+| OpenSUSE 15  | ✅     | Not released |
 
 [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