Skip to content

Commit 926de59

Browse files
authored
deps: require serverkit v1.0.0+ / Support Ruby v2.7+ (#7)
* deps: require serverkit v1.0.0 or more to handle falsy attribute correctly * Support Ruby 2.7+ - ci: CI against Ruby 2.7, 3.0 * Update README.md
1 parent ddec5e0 commit 926de59

File tree

3 files changed

+30
-4
lines changed

3 files changed

+30
-4
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jobs:
66
strategy:
77
matrix:
88
os: [ubuntu-latest, macos-latest]
9-
ruby: ["3.1", "3.2", "3.3", "3.4"]
9+
ruby: ["2.7", "3.0", "3.1", "3.2", "3.3", "3.4"]
1010
runs-on: ${{ matrix.os }}
1111
steps:
1212
- uses: actions/checkout@v4

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,33 @@ gem "serverkit-mise"
1414

1515
## Usage
1616

17-
TODO: Write usage instructions here
17+
### Prerequisites
18+
19+
- Ensure you have [serverkit](https://github.com/serverkit/serverkit) gem installed
20+
- Ensure you have [mise](https://github.com/jdx/mise) installed on your system
21+
22+
### Basic Example
23+
24+
Create a recipe file that uses the mise resources:
25+
26+
```yaml
27+
# recipe.yml
28+
resources:
29+
# Install Node.js using mise
30+
- type: mise_install
31+
name: node
32+
version: 20.10.0
33+
# Install Ruby and set it as global
34+
- type: mise_use
35+
name: ruby
36+
version: 3.3.0
37+
```
38+
39+
Then apply your recipe with Serverkit:
40+
41+
```console
42+
$ serverkit apply recipe.yml
43+
```
1844

1945
## Resource
2046

serverkit-mise.gemspec

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
1212
spec.description = "Serverkit plug-in for mise."
1313
spec.homepage = "https://github.com/serverkit/serverkit-mise"
1414
spec.license = "MIT"
15-
spec.required_ruby_version = ">= 3.1.0"
15+
spec.required_ruby_version = ">= 2.7.0"
1616

1717
spec.metadata["homepage_uri"] = spec.homepage
1818
spec.metadata["source_code_uri"] = "https://github.com/serverkit/serverkit-mise"
@@ -31,5 +31,5 @@ Gem::Specification.new do |spec|
3131
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
3232
spec.require_paths = ["lib"]
3333

34-
spec.add_dependency "serverkit"
34+
spec.add_dependency "serverkit", ">= 1.0.0"
3535
end

0 commit comments

Comments
 (0)