Skip to content

Commit

Permalink
docs: no more @main (#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
hairmare authored May 22, 2023
1 parent 706960d commit 9629e2f
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ that RaBe uses for CI/CD ♻️

See below for copy-pasteable examples of the provided actions.

The examples use `@main` as the target version of the action. You should replace that with the current tag of this repository and also create the following `.github/dependabot.yaml`.
The examples use `@v0.0.0` as the target version of the action. You NEED to replace that with the current tag of this repository and also create the following `.github/dependabot.yaml`.

```yaml title=".github/dependabot.yaml"
version: 2
Expand Down Expand Up @@ -40,7 +40,7 @@ on:
jobs:
release-ansible-collection:
uses: radiorabe/actions/.github/workflows/release-ansible-collection.yaml@main
uses: radiorabe/actions/.github/workflows/release-ansible-collection.yaml@v0.0.0
secrets:
GALAXY_API_KEY: ${{ secrets.GALAXY_API_KEY }} # (1)
```
Expand All @@ -64,7 +64,7 @@ on:
jobs:
test-ansible-collection:
uses: radiorabe/actions/.github/workflows/test-ansible-collection.yaml@main
uses: radiorabe/actions/.github/workflows/test-ansible-collection.yaml@v0.0.0
```

### Container Images
Expand All @@ -88,7 +88,7 @@ on:
jobs:
release-container:
uses: radiorabe/actions/.github/workflows/release-container.yaml@main
uses: radiorabe/actions/.github/workflows/release-container.yaml@v0.0.0
with:
image: 'ghcr.io/radiorabe/<name>' # (1)
name: <name> # (2)
Expand Down Expand Up @@ -128,7 +128,7 @@ on:
jobs:
schedule-trivy:
uses: radiorabe/actions/.github/workflows/schedule-trivy.yaml@main
uses: radiorabe/actions/.github/workflows/schedule-trivy.yaml@v0.0.0
with:
image-ref: 'ghcr.io/radiorabe/<name>:latest' # (1)
```
Expand All @@ -150,15 +150,15 @@ on:
jobs:
pre-commit:
uses: radiorabe/actions/.github/workflows/test-pre-commit.yaml@main
uses: radiorabe/actions/.github/workflows/test-pre-commit.yaml@v0.0.0
```

This runs pre-commit with black and isort installed. If you need more tools you can install them with `pip`.

```yaml title=".github/workflows/test.yaml"
jobs:
pre-commit:
uses: radiorabe/actions/.github/workflows/test-pre-commit.yaml@main
uses: radiorabe/actions/.github/workflows/test-pre-commit.yaml@v0.0.0
with:
requirements: black isort
```
Expand All @@ -181,7 +181,7 @@ on:
jobs:
test-python-poetry:
uses: radiorabe/actions/.github/workflows/test-python-poetry.yaml@main
uses: radiorabe/actions/.github/workflows/test-python-poetry.yaml@v0.0.0
```

Configure your `pyproject.toml` to run pytest and you are good to go.
Expand All @@ -202,7 +202,7 @@ on:
jobs:
python-poetry:
uses: radiorabe/actions/.github/workflows/release-python-poetry.yaml@main
uses: radiorabe/actions/.github/workflows/release-python-poetry.yaml@v0.0.0
secrets:
RABE_PYPI_TOKEN: ${{ secrets.RABE_PYPI_TOKEN }} # (1)
```
Expand Down Expand Up @@ -230,7 +230,7 @@ on:
jobs:
semantic-release:
uses: radiorabe/actions/.github/workflows/semantic-release.yaml@main
uses: radiorabe/actions/.github/workflows/semantic-release.yaml@v0.0.0
secrets:
RABE_ITREAKTION_GITHUB_TOKEN: ${{ secrets.RABE_ITREAKTION_GITHUB_TOKEN }} # (1)
```
Expand Down

0 comments on commit 9629e2f

Please sign in to comment.