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

Instead of picking up the first package manager found, require the user to specify their versioned file. #148

Closed
8 tasks done
Tracked by #98
dbanty opened this issue Mar 10, 2022 · 0 comments · Fixed by #182
Closed
8 tasks done
Tracked by #98
Labels
🥚 breaking change This change will require existing users to change something about their config 🎸 Feature New feature or request
Milestone

Comments

@dbanty
Copy link
Member

dbanty commented Mar 10, 2022

This will enable specifying which file should be edited instead of the arbitrary "first" one being selected.

  • When given a repo with all available metadata filetypes, only the selected one should be affected.
  • No changelogs should be updated if not specified.
  • When calling knope --generate, the first available metadata file (same order picked today) should be added as a package.
  • When a PrepareRelease or BumpVersion step is called without a defined package—an error describing the recommended lines to add (the same thing --generate would output) should be returned to the user.
  • More than one package specified should be an error pointing at Allow specifying multiple, independent packages. #153
  • More than one file in the package should be an error pointing at Allow multiple versioned files in a normal repo (e.g., both a Cargo.toml and a pyproject.toml). #149
  • Update the docs to indicate the [[packages]] pre-req for associated steps including details about how changelog works.
  • Throw a useful error when the listed file in [[packages]] versioned_files is not a supported format
@dbanty dbanty changed the title Instead of picking up the first package manager found, require the user to specify their versioned file. This will enable specifying which file should be edited instead of the arbitrary "first" one being selected. Instead of picking up the first package manager found, require the user to specify their versioned file. Mar 10, 2022
@dbanty dbanty added 🎸 Feature New feature or request 🥚 breaking change This change will require existing users to change something about their config labels Mar 10, 2022
@dbanty dbanty modified the milestones: 0.2.0, 0.3.0 Mar 26, 2022
dbanty added a commit that referenced this issue May 8, 2022
…ically.

Closes #148

BREAKING CHANGE: `BumpVersion` and `PrepareRelease` now require setting a `[[packages]]` field in `knope.toml`.
dbanty added a commit that referenced this issue Jun 6, 2022
…ically.

Closes #148

BREAKING CHANGE: `BumpVersion` and `PrepareRelease` now require setting a `[[packages]]` field in `knope.toml`.
dbanty added a commit that referenced this issue Jun 6, 2022
…ically. (#182)

Closes #148

BREAKING CHANGE: `BumpVersion` and `PrepareRelease` now require setting a `[[packages]]` field in `knope.toml`. The path to a changelog file is no longer defined with `changelog_path` in the `PrepareRelease` step. Instead, it is set as `changelog` in `[[packages]]`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🥚 breaking change This change will require existing users to change something about their config 🎸 Feature New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant