developmentseed / developmentseed/eoapi-cdk

Review usage of Semantic Releases

Open
#37 2 comments 1 reaction 0 assignees View on GitHub
question
Dominant language
Python
Stars
29
Forks
6
Avg merge
1d 2h
Merged PRs (30d)
7

Description

Is the system of Semantic Releases more trouble than its worth? I am a bit of an optimist on the strategy, but others have described it as opaque and too much magic. Should we remove it from our build system?

Pros:

* Automation means releases are near-instant.
* Busywork (e.g. upping the package version, writing release notes) are automated

Cons:

* Requires a commitment to Conventional Commits
* More challenge around understanding what the impact of commit will be (ie what will the be the resultant version change?)
* Many small (single-change) releases (I'm admittedly not sure if this is actually a bad thing)

My urge to is to lean more into the strategy and build in more CI tooling that would:
* reject PRs that don't comply with conventional commit standards (although, I think #25 recently added this)
* comment on a PR informing the user of what the next version will be if the PR is merged.

Thoughts @sharkinsspatial @emileten ?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.