Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only refer to the major version of the actions #58

Merged
merged 1 commit into from
Nov 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions actions/dropbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
dropbox:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/dropbox@vx.y.z
- uses: paddyroddy/.github/actions/dropbox@vx
with:
configfile-version: ${{ secrets.CONFIGFILE_VERSION }}
files-to-upload: $(find . -maxdepth 1 -name '*.pdf' -print)
Expand All @@ -16,4 +16,4 @@ jobs:
oauth-refresh-token: ${{ secrets.OAUTH_REFRESH_TOKEN }}
```

where `x.y.z` is the `major.minor.patch` version of the action.
where `x` is the `major` version of the action.
4 changes: 2 additions & 2 deletions actions/latex/chktex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
chktex:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/latex/chktex@vx.y.z
- uses: paddyroddy/.github/actions/latex/chktex@vx
```

where `x.y.z` is the `major.minor.patch` version of the action.
where `x` is the `major` version of the action.
4 changes: 2 additions & 2 deletions actions/latex/compile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
compile-latex:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/latex/compile@vx.y.z
- uses: paddyroddy/.github/actions/latex/compile@vx
```

where `x.y.z` is the `major.minor.patch` version of the action.
where `x` is the `major` version of the action.
6 changes: 3 additions & 3 deletions actions/latex/vale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ jobs:
vale:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/latex/vale@vx.y.z
- uses: paddyroddy/.github/actions/latex/vale@vx
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
```

where `x.y.z` is the `major.minor.patch` version of the action. If flags are
where `x` is the `major` version of the action. If flags are
required for vale, then modify the above to:

```yaml
jobs:
vale:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/latex/vale@vx.y.z
- uses: paddyroddy/.github/actions/latex/vale@vx
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
vale-flags: ""
Expand Down
4 changes: 2 additions & 2 deletions actions/licence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ jobs:
licence:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/licence@vx.y.z
- uses: paddyroddy/.github/actions/licence@vx
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
licence-file: ./LICENCE.md
```

where `x.y.z` is the `major.minor.patch` version of the action.
where `x` is the `major` version of the action.
4 changes: 2 additions & 2 deletions actions/linting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ jobs:
linting:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/linting@vx.y.z
- uses: paddyroddy/.github/actions/linting@vx
with:
pre-commit-config: ./.pre-commit-config.yaml
```

where `x.y.z` is the `major.minor.patch` version of the action.
where `x` is the `major` version of the action.
4 changes: 2 additions & 2 deletions actions/python/deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/python/deployment@vx.y.z
- uses: paddyroddy/.github/actions/python/deployment@vx
with:
pypi-api-token: ${{ secrets.PYPI_API_TOKEN }}
pyproject-toml: ./pyproject.toml
python-version: "3.x"
test-pypi-api-token: ${{ secrets.TEST_PYPI_API_TOKEN }}
```

where `x.y.z` is the `major.minor.patch` version of the action.
where `x` is the `major` version of the action.
4 changes: 2 additions & 2 deletions actions/python/pdoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
documentation:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/python/pdoc@vx.y.z
- uses: paddyroddy/.github/actions/python/pdoc@vx
with:
docs-dependency-section: .[docs]
gh-pages-publish-directory: ./html/python_project
Expand All @@ -18,4 +18,4 @@ jobs:
template-directory: ./documentation
```

where `x.y.z` is the `major.minor.patch` version of the action.
where `x` is the `major` version of the action.
6 changes: 3 additions & 3 deletions actions/python/tox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
python-version:
- "3.x"
steps:
- uses: paddyroddy/.github/actions/python/tox@vx.y.z
- uses: paddyroddy/.github/actions/python/tox@vx
with:
cache-path: |-
.tox
Expand All @@ -26,7 +26,7 @@ jobs:
python-version: ${{ matrix.python-version }}
```

where `x.y.z` is the `major.minor.patch` version of the action. If coverage with
where `x` is the `major` version of the action. If coverage with
Coveralls is not desired, then modify the above to:

```yaml
Expand All @@ -44,7 +44,7 @@ jobs:
python-version:
- "3.x"
steps:
- uses: paddyroddy/.github/actions/python/tox@vx.y.z
- uses: paddyroddy/.github/actions/python/tox@vx
with:
cache-path: |-
.tox
Expand Down
4 changes: 2 additions & 2 deletions actions/ruby/jekyll/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: paddyroddy/.github/actions/ruby/jekyll@vx.y.z
- uses: paddyroddy/.github/actions/ruby/jekyll@vx
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
ruby-version: "3.2"
```

where `x.y.z` is the `major.minor.patch` version of the action.
where `x` is the `major` version of the action.