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.

Sign up for GitHub

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

Jump to bottom

Update release notes and changelog #362

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Update release notes and changelog #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d05d14
docs(changelog): Fix version header for previous release notes
alerque Oct 9, 2020
4f13eee
docs(changelog): Add release notes for work to date since last tag
alerque Oct 9, 2020
9649b94
docs(contributing): Update release procedure notes
alerque Oct 9, 2020
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
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ see [CONTRIBUTING.md](CONTRIBUTING.md#release-instructions-for-a-new-version) fo

## unreleased

- refactor: Begin migration of test suite to Busted
- docs: Make documentation pages more navigable
- chore: Remove incrementing version from development Rockspec (`SCM-3`->`dev-1`)
- deprecate: `permute.iter`, renamed to `permute.order_iter` (removal later)
[#360](https://github.com/lunarmodules/Penlight/pull/360)
- deprecate: `permute.table`, renamed to `permute.order_table` (removal later)
Expand All @@ -14,7 +17,7 @@ see [CONTRIBUTING.md](CONTRIBUTING.md#release-instructions-for-a-new-version) fo
[#360](https://github.com/lunarmodules/Penlight/pull/360)


## 1.9.1 (2020-09-27)
## 1.9.2 (2020-09-27)

- fix: dir.walk [#350](https://github.com/lunarmodules/Penlight/pull/350)

Expand Down
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 .`
Expand Down