makspll / makspll/bevy_mod_scripting

Semver Checks + Changelog dry run actions in CI

Open
#365 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement good first issue
Dominant language
Rust
Stars
649
Forks
59
PR merge metrics
No merged PRs in 30d

Description

I don't want to keep having to wrestle release-plz commits onto main before seeing what they will do.

I'd like to have a dry run action for release-plz or at least git cliff that will allow developing that config before merging to main.

I would also like to run cargo-semver-checks on each PR, and fail the PR if it's conventional commit doesn't cover a breaking change, I want to have better breaking change hygiene, and automatically collect migration guides eventually

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing CI configuration and the release-plz or git cliff configuration. Check how cargo-semver-checks and conventional commits can run on each pull request, then define done as a dry-run release workflow plus checks that fail when a breaking change is not represented.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github-actions, rust
Domain
build-system, ci-cd, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.