Skip to content

Use version number for GitHub release name - #1223

Merged
CppCXY merged 1 commit into
EmmyLuaLs:mainfrom
notpeter:release_name
Aug 14, 2026
Merged

Use version number for GitHub release name#1223
CppCXY merged 1 commit into
EmmyLuaLs:mainfrom
notpeter:release_name

Conversation

@notpeter

Copy link
Copy Markdown
Contributor

Currently every GitHub release has the same hard coded name: emmylua_ls.
So it's a pain to actually see the version list:

Screenshot 2026-08-14 at 13 16 15

This PR fixes the GitHub action and you can easily rename historical releases with:

gh release edit 0.25.1 --title 0.25.1
gh release edit 0.25.0 --title 0.25.0
gh release edit 0.24.0 --title 0.24.0
gh release edit 0.23.2 --title 0.23.2
gh release edit 0.23.1 --title 0.23.1
gh release edit 0.23.0 --title 0.23.0
gh release edit 0.22.0 --title 0.22.0
gh release edit 0.21.0 --title 0.21.0
gh release edit 0.20.0 --title 0.20.0
gh release edit 0.19.0 --title 0.19.0
gh release edit 0.18.0 --title 0.18.0
gh release edit 0.17.0 --title 0.17.0
gh release edit 0.16.0 --title 0.16.0
gh release edit 0.15.0 --title 0.15.0
gh release edit 0.14.0 --title 0.14.0
gh release edit 0.13.0 --title 0.13.0
gh release edit 0.12.0 --title 0.12.0
gh release edit 0.11.0 --title 0.11.0
gh release edit 0.10.0 --title 0.10.0
gh release edit 0.9.1 --title 0.9.1
gh release edit 0.9.0 --title 0.9.0
gh release edit 0.8.2 --title 0.8.2
gh release edit 0.8.1 --title 0.8.1
gh release edit 0.8.0 --title 0.8.0
gh release edit 0.7.3 --title 0.7.3
gh release edit 0.7.2 --title 0.7.2
gh release edit 0.7.1 --title 0.7.1
gh release edit 0.7.0 --title 0.7.0
gh release edit 0.6.0 --title 0.6.0
gh release edit 0.5.4 --title 0.5.4
gh release edit 0.5.3 --title 0.5.3
gh release edit 0.5.2 --title 0.5.2
gh release edit 0.5.1 --title 0.5.1
gh release edit 0.5.0 --title 0.5.0
gh release edit 0.4.6 --title 0.4.6
gh release edit 0.4.5 --title 0.4.5
gh release edit 0.4.4 --title 0.4.4
gh release edit 0.4.3 --title 0.4.3
gh release edit 0.4.2 --title 0.4.2
gh release edit 0.4.1 --title 0.4.1
gh release edit 0.3.3 --title 0.3.3
gh release edit 0.3.2 --title 0.3.2
gh release edit 0.3.1 --title 0.3.1
gh release edit 0.3.0 --title 0.3.0
gh release edit 0.2.9 --title 0.2.9
gh release edit 0.2.8 --title 0.2.8
gh release edit 0.2.7 --title 0.2.7
gh release edit 0.2.6 --title 0.2.6
gh release edit 0.2.5 --title 0.2.5
gh release edit 0.2.4 --title 0.2.4
gh release edit 0.2.2 --title 0.2.2
gh release edit 0.2.1 --title 0.2.1
gh release edit 0.2.0 --title 0.2.0
gh release edit 0.1.7 --title 0.1.7
gh release edit 0.1.6 --title 0.1.6
gh release edit 0.1.5 --title 0.1.5
gh release edit 0.1.4 --title 0.1.4
gh release edit 0.1.3 --title 0.1.3
gh release edit 0.1.2 --title 0.1.2
gh release edit 0.1.1 --title 0.1.1
gh release edit 0.1.0 --title 0.1.0

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll review this code change to the GitHub Actions workflow file.

Summary

The change modifies the release name in the GitHub Actions workflow from a hardcoded string "emmylua_ls" to use the GitHub reference name (${{ github.ref_name }}).

Issues Found

1. Potential Inconsistent Release Names

  • Problem: The release name will now be the tag name (e.g., "v1.2.3") instead of the consistent "emmylua_ls" name. This could break any external scripts, documentation, or processes that expect a consistent release name.
  • Suggestion: Consider whether this change is intentional and if any downstream consumers depend on the old naming convention.

2. Missing Context for Tag Events

  • Problem: The github.ref_name will only contain a meaningful value when the workflow is triggered by a tag push or release event. If this workflow can also be triggered by other events (like push to main branch), the release name could be unexpected (e.g., "main").
  • Suggestion: Verify that this job only runs on tag events. If not, add a condition like if: startsWith(github.ref, 'refs/tags/') to ensure it only runs for tags.

3. No Fallback or Validation

  • Problem: There's no validation or fallback if github.ref_name is empty or contains unexpected characters.
  • Suggestion: Consider adding a fallback or validation step, for example:
    name: ${{ github.ref_name != '' && github.ref_name || 'emmylua_ls' }}

4. Potential Security Consideration

  • Problem: Using github.ref_name directly in the release name could allow injection of special characters if the tag name contains malicious content (though this is low risk since tags are typically controlled by maintainers).
  • Suggestion: Consider sanitizing the input or using a more controlled naming convention.

Recommendations

  1. Confirm Intent: Ensure this change is intentional and that no external tools depend on the old "emmylua_ls" release name.

  2. Add Event Guard: If this job can run on non-tag events, add a condition to ensure it only runs for tag pushes:

    if: startsWith(github.ref, 'refs/tags/')
  3. Consider a More Descriptive Name: Instead of just the tag name, you might want to include the project name for clarity:

    name: emmylua_ls ${{ github.ref_name }}
  4. Test the Change: Verify that the release creation works correctly with the new naming convention by testing with a sample tag.

Overall Assessment

The change is straightforward and likely intended to make release names more descriptive by including the version/tag. However, it introduces potential issues with consistency and event handling that should be addressed before merging.

@CppCXY
CppCXY merged commit aaaca68 into EmmyLuaLs:main Aug 14, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants