#714 feature(create): added option 'index' which allows direct access to indexed snippets

[tirolerstefan]

Fixes #714

Towncried currently adds an index if a snippet already exists, e.g. issue-1234.feat.md is available, so issue-1234.feat.1.md is created.

We have a graphical tool for changelog snippet creation and wanted to directly access the indexed snippets - so an overwrite is possible.

With this change, a new option "--index" is added.

e.g.

towncrier create --dir .../changelogs/preliminary --config .../config/changelogs/towncrier.toml --section BLA --content "test3<br/>
    another snippet" --index 8 ISSUE-1000.feat.md
Created news fragment at .../changelogs/preliminary/BLA/ISSUE-1000.feat.8.md

If index == 0, the filename without index is accessed.
If index > 0, the index is added to the filename.

If option "index" is not passed, the tool behaves as before - the next index is chosen.

[adiroiban]

Hi Stefan.

Thanks for the PR.

It might be the case that our pre-commit is not yet ready for Python 3.15

I will take a look

[tirolerstefan]

Thanks a lot for checking this.
Note: Currently I'm using Python 3.12.3 on Ubuntu 24.04.

[adiroiban]

Can you push your changes using git --no-verify ... I will check the pre-commit errors.
They might not be related to this PR

[tirolerstefan]

My changes are pushed and up2date. All I wanted to commit are the fixes for the hooks. Thanks!

[adiroiban]

Thanks for the PR and sorry for the late review.

I left a few inline comments.

To merge, this PR needs updated autoamted tests.

Thanks again

[adiroiban]

is this change needed?

[tirolerstefan]

this was one of the "auto fixes" of pre-commit.
no, it's not needed in my eyes, but i have to commit it using "--no-verify".
if you don't mind, i will leave it as it is to satisfy the pre-commit tools.

[adiroiban]

Index is kind of generic...
Maybe it's best to be more explicit to prevent future conflicts and confusions/

Suggested change

	"--index",
	"--issue-index",

I don't know if "index" is the best name for this feature... maybe we can call it --sub-issue or someting like that

[tirolerstefan]

hmmm, it's like an index - 0 is the first fragment, 1 the next, etc. but i can live with any text.
"sub-issue" is totally ok, "sub-fragment" or "fragment-number", "fragment-id", "sub-id"?

[tirolerstefan]

hi @adiroiban - thanks, i have added my comments above and pushed a new commit.
waiting for the final naming of the option, then i will adapt this, too.