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

Invalid version reference of GitHub Action example in README #45

Open
stschaefers opened this issue Apr 26, 2024 · 0 comments
Open

Invalid version reference of GitHub Action example in README #45

stschaefers opened this issue Apr 26, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@stschaefers
Copy link
Contributor

Bug Description

The README file shows an example how to use the gates GitHub Action. The version reference is consid-germany/[email protected] but it has to be consid-germany/[email protected] because the git version tags are prefixed with v.

gates/README.md

Lines 35 to 48 in 113f2cf

```yaml
jobs:
example:
permissions:
id-token: write
runs-on: ubuntu-latest
steps:
- uses: consid-germany/[email protected]
with:
gitHubApiBaseUrl: https://github.gates.consid.tech/api
group: some-group
service: some-service
environment: test
```

To Reproduce

  1. Go to https://github.com/consid-germany/gates
  2. Scroll down to Quick Start - GitHub Action

Expected Behavior

The GitHub Action example shows a working example with the correct git version tag. We could also think about adding and using a major git tag for the GitHub Action such as consid-germany/gates@v1.

Additional Context

Version @consid-germany/[email protected]

@stschaefers stschaefers added the bug Something isn't working label Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant