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

Update release notes and changelog #362

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
Changes from 1 commit
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
Prev Previous commit
docs(contributing): Update release procedure notes
Co-authored-by: Thijs Schreijer <[email protected]>
alerque and Tieske committed Oct 9, 2020

Verified

This commit was signed with the committer’s verified signature.
alerque Caleb Maclennan
commit 9649b94accedee181618bcb4bc4b68135662d24d
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -46,7 +46,8 @@ before making more changes - that way we can take in each change separately.
- create a new release branch
- update `./lua/pl/utils.lua` (the `_VERSION` constant)
- update `./config.ld` with the new version number
- create a new rockspec file for the version in `./rockspecs`
- copy dev rockspec file to release filename in in `./rockspecs` and match version in rockspec
- [until we hit 2.0.0] edit rockspec, drop `description.issue_url`, `test_dependencies`, `test`, and `rockspec_format` keys
- check the `./CHANGELOG.md` files for completeness
- commit the release related changes
- render the documentation using `ldoc .`