Skip to content
This repository was archived by the owner on Mar 4, 2021. It is now read-only.
This repository was archived by the owner on Mar 4, 2021. It is now read-only.

README instructs users to do strange things to their repositories. #116

@emctague

Description

@emctague

The example use of create-release in the README contains this line:

          tag_name: ${{ github.ref }}

Should a user leave this in while having actions set to trigger for their master/main branch, this will result in a new tag being created called refs/heads/main... This means:

  1. The tag will be the same every time the action tries to create a release

  2. After this action is triggered, trying to simply push to the repository (e.g. git push or git push origin master) will not work. Users will probably try to delete the tag... Examples for "delete a tag" found across the internet look like git push origin :refs/tags/main. The proper way to delete this tag is git push origin :refs/tags/refs/heads/main, but users will probably mistakenly run other commands such as git push --delete origin :refs/heads/main due to the confusing name of this tag, deleting their remote main branch.

I suggest changing the tag_name line in the README's example use to something along the lines of tag_name: release-${{ github.sha }} to ensure the example works out-of-the-box without any unusual issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions