Skip to content

ci, doc: add semver workflow and PR template #875

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

Merged
merged 3 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Summary

<!-- Give a brief description of what your PR does. -->

This PR adds..

## Related Issues

<!-- Link issues that are related to this PR. You may link issues you think should be closed by this PR. -->

Related #

Closes #

## Changes

<!-- List the major changes made in this PR. -->

- List changes here

## Checklist

I confirm that I have:

- [ ] **Followed the
[Conventional Commits](https://www.conventionalcommits.org/)
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.
19 changes: 19 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
on:
push:
branches:
- master

permissions:
contents: write
pull-requests: write

name: release-please

jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: googleapis/release-please-action@v4
with:
token: ${{ secrets.GH_TOKEN }}
release-type: simple
6 changes: 6 additions & 0 deletions docs/contributing.org
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,9 @@ make test FILE=./tests/plenary/api/api_spec.lua
:CUSTOM_ID: parser
:END:
Parsing is done via builtin treesitter parser and the [[https://github.com/milisims/tree-sitter-org][tree-sitter-org]] grammar.

**** Commits
:PROPERTIES:
:CUSTOM_ID: commits
:END:
Ensure that you follow the [[https://www.conventionalcommits.org/][Conventional Commits]] specification (e.g., =feat: add new feature=, =fix: correct bug=, =docs: update documentation=).
Loading