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

Is the example in the README correct? #11

Closed
AdamGagorik opened this issue Apr 13, 2022 · 3 comments · Fixed by #12
Closed

Is the example in the README correct? #11

AdamGagorik opened this issue Apr 13, 2022 · 3 comments · Fixed by #12
Assignees

Comments

@AdamGagorik
Copy link

I have tried the example in the README in a workflow.

- name: Use Docker in rootless mode.
  uses: ScribeMD/rootless-docker@0

I observe the following error:

Error: Unable to resolve action ScribeMD/rootless-docker@0, unable to find version 0

@AdamGagorik
Copy link
Author

Works if I am more explicit on the release tag.

- name: Use Docker in rootless mode.
  uses: ScribeMD/rootless-docker@0.1.1

@Kurt-von-Laven Kurt-von-Laven self-assigned this Apr 13, 2022
@Kurt-von-Laven
Copy link
Contributor

Kurt-von-Laven commented Apr 13, 2022

@AdamGagorik, thank you for reporting this rather glaring issue. I misinterpreted GitHub's docs to suggest that GitHub Actions understands semantic versioning:

Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work. ~ jobs.<job_id>.steps[*].uses

However, if users want to be able to reference a major version, the action maintainer has to tag it themselves. I personally feel most users will benefit from pinning a specific version so that they don't need to worry about a dependency breaking them. Dependabot can automatically update these version numbers as often as desired, which seems safer than depending on a major version. I updated the README to show a specific version instead and have filed github/docs#17071 requesting a clarification of GitHub's documentation.

@Kurt-von-Laven
Copy link
Contributor

github/docs#17776 was recently merged, clarifying the upstream documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

2 participants