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

[TABJS-1] Add lerna functionality for at least one of: changelog, release, or tags #76

Open
dtbuchholz opened this issue Nov 9, 2023 · 0 comments
Labels
chore Something that needs doing Medium priority Created by Linear-GitHub Sync

Comments

@dtbuchholz
Copy link
Contributor

Summary

The current lerna setup does not publish any information on what new releases have occurred. This is problematic from an end user's perspective because it's difficult to see the release history and what's changed. It's also problematic from a Weeknotes project perspective because we want to automate the collection of release notes (e.g., via a bot that hits https://github.com/tablelandnetwork/tableland-js/releases) and then manually include that information in Weeknotes content.

Details

There are a few ways that lerna enables this functionality, but this needs more research. For example, the lerna release version --conventional-commits will bump package versions automatically, add tags, and create a CHANGELOG.md file that looks something like this within each packages/<name> directory:

# Change Log

All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

# 5.0.0 (2023-11-09)


### Bug Fixes

* **chains:** filter out op goerli staging ([082a313](https://github.com/tablelandnetwork/tableland-js/commit/082a31346b60c7cc67b24b21e0eb8c3a9c73213f))
* **sdk:** D1 API compatability; use opts for db/stmt ([1f310cc](https://github.com/tablelandnetwork/tableland-js/commit/1f310cc1f2025d182a698382adfdae271508220e))
* **sdk:** handle `first` overload where opts not parsed correctly ([2d7a75e](https://github.com/tablelandnetwork/tableland-js/commit/2d7a75e984d1a102d8956fdb4d345efb94a299cd))


### Features

* **sdk:** add `isPollingController` helper ([45c66cd](https://github.com/tablelandnetwork/tableland-js/commit/45c66cd0f7a779dbb4515e01a118d6f152a05d67))
* **sdk:** add per-chain polling info & controller creation ([8196e08](https://github.com/tablelandnetwork/tableland-js/commit/8196e08edff5037fd372969ed0da204a127afa5c))
* **sdk:** D1 `exec` conformance via `ExecResult`, `wrapExecResult` ([0312010](https://github.com/tablelandnetwork/tableland-js/commit/0312010899de4b0bafa48140b1c9ca308df6d51c))
* **sdk:** remove jsonFileAliases & refactor tests with node-helpers ([56213c1](https://github.com/tablelandnetwork/tableland-js/commit/56213c1ecc8cdac5987c138e3244724be99e7085))
* **sdk:** update for D1 type conformance ([4f8d917](https://github.com/tablelandnetwork/tableland-js/commit/4f8d9174f9a6d00ab9d44bdb6d0b57ea46ee9a18))
* **sdk:** use per-chain controller for receipt ([f29e6ce](https://github.com/tablelandnetwork/tableland-js/commit/f29e6ce497933d980762ce852f89b93b75cf5afb))

From SyncLinear.com | TABJS-1

@dtbuchholz dtbuchholz added Medium priority Created by Linear-GitHub Sync chore Something that needs doing labels Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Something that needs doing Medium priority Created by Linear-GitHub Sync
Projects
None yet
Development

No branches or pull requests

1 participant