Skip to content

Commit

Permalink
Document Smart Proxy plugin test in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ekohl committed Nov 12, 2024
1 parent 6c150bb commit 385b10d
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,32 @@ By default, this will run with the NodeJS versions that is configured in Foreman

You can alter the behavior the same way as with the Ruby tests.

## Smart Proxy plugin test

Similar to the Foreman plugin test, this is aimed at Smart Proxy plugins.
Conceptually it verifies certain Ruby versions are supported and using `test-gem.yml` to run the tests.

```
name: CI

on: pull_request

concurrency:
group: ${{ github.ref_name }}-${{ github.workflow }}
cancel-in-progress: true

jobs:
test:
name: Tests
uses: theforeman/actions/.github/workflows/smart_proxy_plugin.yml@v0
```
It's possible to provide `foreman_proxy_version` via a parameter, but your `Gemfile` needs to respect this:
```ruby
gem 'smart_proxy', github: "theforeman/smart-proxy", branch: ENV.fetch('SMART_PROXY_BRANCH', 'develop')
```

## Gem test

To test a simple gem that only needs Ruby and bundler, use the following workflow:
Expand Down

0 comments on commit 385b10d

Please sign in to comment.