iamjackg / md2cf

Convert and upload Markdown documents to Confluence
MIT License
91 stars 49 forks source link

Feature Addition: "Autogenerated" Label Validation #85

Open pmarchini opened 1 year ago

pmarchini commented 1 year ago

Hey there,

In the process of using md2cf, I've implemented an additional feature that could be beneficial to the wider community.

Below is a summary of the new feature:

Autogenerated Label Validation: I've introduced a new flag --check-autogenerated-label which, when activated, checks for a 'marker' label on the Confluence pages.
This marker indicates if the page was autogenerated. The name of the marker label can be provided via --autogenerated-flag-label.
If a page that's going to be updated doesn't have this label, the script will prompt the user and ask whether they wish to proceed with the update.

This feature aims to prevent accidental overwriting of manually created pages when mass updating pages via the script. I've developed an initial implementation to satisfy my immediate requirements, but I'm willing to develop a cleaner, more robust version if this feature is deemed useful for the project.

I would be delighted to hear your thoughts on this proposed enhancement.

iamjackg commented 10 months ago

Oh, that's interesting! I don't love the idea of prompting the user, since I built md2cf with automated pipelines in mind. This could perhaps be better implemented as a flag that makes the script stop when it encounters a page missing the tag?