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

ci: automated releases and luarocks uploads #1923

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mrcjkb
Copy link
Contributor

@mrcjkb mrcjkb commented May 13, 2024

Hey 👋

This PR introduces a release-please workflow that automatically opens (or updates) a release PR (which updates a changelog) when a conventional commit is merged into the main branch.

Here's an example of what a release PR looks like:

The nice thing about this workflow is that you get to decide when to merge a release PR.
When doing so, the same workflow creates a release tag and publishes a GitHub release, with the (SemVer) version bump determined from the conventional commit messages.

If you add a personal access token to this repo's secrets (I assumed it to be named PAT in this PR), each release will automatically trigger a luarocks upload. I have modified the workflow file to work nicely with this.

Important

  • If you merge this as is, release-please will compute the version using previous
    conventional commit messages. As there has not been a release yet,
    it will likely start at version 1.0.0. You can change the initial version with a manifest file.
  • Commits that don't comply with the conventional commits spec won't be
    included in release notes. You could enforce this with a GitHub action. Personally, I haven't ever had a need to do so.

- uses: google-github-actions/release-please-action@v4
with:
release-type: simple
token: ${{ secrets.PAT }}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This personal access token would need to be added to this repo's secrets.

@mrcjkb
Copy link
Contributor Author

mrcjkb commented Jun 24, 2024

@hrsh7th no interest in this?

The luarocks package and latest tag being so out of date is a bit of a footgun for luarocks/rocks.nvim users.

@max397574
Copy link
Contributor

The luarocks package and latest tag being so out of date is a bit of a footgun for luarocks/rocks.nvim users.

and this days also lazy.nvim
it could happen that it automatically uses the rockspec with the outdated things

@mrcjkb
Copy link
Contributor Author

mrcjkb commented Jul 25, 2024

Since we haven't received a response, we've removed nvim-cmp 0.0.1 from the luarocks.org root manifest and uploaded a dev one (which installs from scm).

This isn't ideal, because dev rocks can't be pinned to a revision, but at least luarocks/rocks.nvim users can use an up-to-date version of this plugin.

If you ever decide to merge this, please let me know, because we will have to relinquish our rock.

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.

luarocks package very outdated Releases and release automation
2 participants