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, doc: add semver workflow and PR template #875

Merged
merged 3 commits into from
Jan 31, 2025

Conversation

ficcdaf
Copy link
Contributor

@ficcdaf ficcdaf commented Jan 30, 2025

Summary

This PR adds a GitHub actions workflow to automate the creation of semantically versioned releases with release-please and a PR template to encourage compliance with conventional commits.

Related Issues

Closes #828

Changes

  • Added release-please workflow
  • Added PR template
  • Updated Contributing documentation to mention conventional commits

Checklist

I confirm that I have:

  • Followed the
    Conventional Commits
    specification
    (e.g., feat: add new feature, fix: correct bug,
    docs: update documentation).
  • My PR title also follows the conventional commits specification.
  • Updated relevant documentation, if necessary.
  • Thoroughly tested my changes.
  • Added tests (if applicable) and verified existing tests pass with
    make test.
  • Checked for breaking changes and documented them, if any.

@ficcdaf ficcdaf changed the title Add semver workflow ci, doc: add semver workflow and PR template Jan 30, 2025
.github/workflows/release.yml Outdated Show resolved Hide resolved
.github/workflows/release.yml Outdated Show resolved Hide resolved
@mrcjkb
Copy link
Contributor

mrcjkb commented Jan 30, 2025

I'm not sure, but this might need a manifest to tell release-please about the initial version and which commit to bootstrap at.

@ficcdaf
Copy link
Contributor Author

ficcdaf commented Jan 30, 2025

I'm not sure, but this might need a manifest to tell release-please about the initial version and which commit to bootstrap at.

Hmm, I believe release-please just starts with the latest release version. Ie as soon as the workflow is merged and it runs, it'll automatically process all the commits pushed since the last release and add them to the release PR; and it'll start keeping track of semver bumps from the last release onwards. So it won't try to calculate the version number from the start of the repo history, If that's what you're worried about.

Is this what you mean by telling it the initial version? (Thanks for your patience btw)

Copy link
Member

@kristijanhusak kristijanhusak left a comment

Choose a reason for hiding this comment

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

Generally looks good. Lets just fix these few comments and then we'll give it a try.

.github/workflows/release.yml Outdated Show resolved Hide resolved
.github/workflows/release.yml Outdated Show resolved Hide resolved
@ficcdaf ficcdaf force-pushed the add-semver-workflow branch from 7377040 to 614e6a8 Compare January 31, 2025 00:27
@ficcdaf
Copy link
Contributor Author

ficcdaf commented Jan 31, 2025

Ok, I added the correct github token and changed the branch name to master

Copy link
Member

@kristijanhusak kristijanhusak left a comment

Choose a reason for hiding this comment

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

Ok, looks good. Let see how it goes.
Thanks!

@kristijanhusak kristijanhusak merged commit fa6d7fe into nvim-orgmode:master Jan 31, 2025
6 checks passed
@ficcdaf
Copy link
Contributor Author

ficcdaf commented Jan 31, 2025

Thank you! I'm very excited to have contributed. I hope the workflow and the PR template helps to make maintaining the repo a bit easier. Thanks for your hard work on this plugin!

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.

Automated workflow for semantic releases
3 participants