towncrier icon indicating copy to clipboard operation
towncrier copied to clipboard

Remove incremental

Open SmileyChris opened this issue 1 year ago • 9 comments

Description

Remove Incremental as a requirement (but still support its use for project versions/names)

Fixes #308 and #398

Checklist

  • [x] Make sure changes are covered by existing or new tests.
  • [x] For at least one Python version, make sure local test run is green.
  • [x] Create a file in src/towncrier/newsfragments/. Describe your change and include important information. Your change will be included in the public release notes.
  • [x] Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
  • [x] Ensure docs/tutorial.rst is still up-to-date.
  • [x] If you add new CLI arguments (or change the meaning of existing ones), make sure docs/cli.rst reflects those changes.
  • [x] If you add new configuration options (or change the meaning of existing ones), make sure docs/configuration.rst reflects those changes.

SmileyChris avatar Mar 27 '23 04:03 SmileyChris

Codecov Report

Patch coverage: 86.04% and project coverage change: -0.80 :warning:

Comparison is base (70da86f) 99.84% compared to head (8667326) 99.05%.

:exclamation: Current head 8667326 differs from pull request most recent head aa5e214. Consider uploading reports for the commit aa5e214 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##            trunk     #491      +/-   ##
==========================================
- Coverage   99.84%   99.05%   -0.80%     
==========================================
  Files          13       12       -1     
  Lines         631      632       +1     
  Branches      146      143       -3     
==========================================
- Hits          630      626       -4     
- Misses          0        4       +4     
- Partials        1        2       +1     
Impacted Files Coverage Δ
src/towncrier/__init__.py 100.00% <ø> (ø)
src/towncrier/_shell.py 89.47% <66.66%> (-10.53%) :arrow_down:
src/towncrier/_settings/load.py 98.01% <84.61%> (-1.99%) :arrow_down:
src/towncrier/_project.py 95.74% <88.88%> (-4.26%) :arrow_down:
src/towncrier/build.py 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Mar 27 '23 04:03 codecov[bot]

Thanks, Chris for working on this.

I am working to make a new release of towncrier, and the plan is to drop 3.7 support.

So this PR should be even simpler.

I am happy to drop the incremental dependency from towncrier. I think that managing it via a simple string is good enough. The version should only be modified by the release manager and the release manager should be familiar with the versioning scheme.

I think that using Version('towncrier', 19, 9, 0, release_candidate=1) instead of just 19.9.0.rc1 is overengineering

adiroiban avatar Jun 05 '23 09:06 adiroiban

@adiroiban cool! I'd say merge this first then work on dropping the 3.7 support, otherwise I can update this after you've changed the automated tests so this doesn't fail when I remove the import try/excepts.

(also a review of #482 would be nice, it would be a good addition before the new release ;) )

SmileyChris avatar Jun 05 '23 23:06 SmileyChris

@SmileyChris #482 it's on my todo list... but we can trigger a release anytime.

adiroiban avatar Jun 07 '23 13:06 adiroiban

JFTR: if you'd like to entertain the idea of using hatch-vcs to deduplicate version information, I'm happy to help. I used to be skeptical to the idea, but now I've moved all my projects to it. If configured correctly, it also allows for continuous uploads to Test PyPI: https://test.pypi.org/project/structlog/#history

I guess the "you" here is mostly towards @adiroiban since he's doing all the release work and @glyph because he's The Twisted King.

hynek avatar Jun 12 '23 14:06 hynek

To me hatch-vcs is over-engineering. I am not sure what problem it tries to solve.

Is it that hard to keep the version as a text inside a .toml file? :)

adiroiban avatar Jun 12 '23 14:06 adiroiban

Well, it's not. :) But it deduplicates the version information to one place (we do git tags too) and enables the continuous uploads I've mentioned. But obviously, if you don't want it, it's not happening. Just wanted to offer. :)

hynek avatar Jun 12 '23 14:06 hynek

this needs a rebase / conflict resolution

hynek avatar Jun 23 '23 09:06 hynek

Removed the python 3.7 related fallbacks, updated the version in the toml, and rebased against trunk. (and pushing again with no change because the checknewsfragment test failed for no good reason 😖 )

SmileyChris avatar Jun 23 '23 12:06 SmileyChris

Hi @adiroiban @SmileyChris is this PR stale and ready to be picked up by someone else? Or are you planning to continue work?

sigma67 avatar Jul 26 '24 19:07 sigma67

Hi @sigma67

This PR is stale.

If you have time, feel free to continue working on it.

Thanks

adiroiban avatar Jul 27 '24 16:07 adiroiban

Hi @adiroiban, thanks, I've picked it up in #627

sigma67 avatar Jul 28 '24 10:07 sigma67

I am closing this as the current effort is with https://github.com/twisted/towncrier/pull/627

adiroiban avatar Jul 29 '24 08:07 adiroiban