dialpad/confluence-docs-sync

A GitHub Action to sync doc files with Confluence

confluence-docs-sync's Issues

Delete/archive wiki page when source file is deleted

When foo.md is deleted, or renamed bar.md or moved to baz/qux.md, the original page should be deleted as well.

This is tricky because you don't really delete a page in Confluence - you archive it, then it can be deleted from the archive. There are several problems:

• the user may have permission to archive a page, but not to delete it
• if the file is added back later and the page is still in the archived state, the script will try to update it (since it already exists), but won't be able to (because an archived page is read-only)

Properly handle relative links

Relative links like ../src/my_source_file.py don't work when seen on wiki. One can navigate to the original page on GitHub and click on the link there, but we could detect these links and figure out how to replace them:

• for image files, embed the image
• for files that have an associated Confluence page, add a link to that page
• for everything else, link to GitHub

Add test framework

It should be fairly easy to add tests for the method that checks whether a file should be synced.

Even better would be to be able to mock the Confluence client and assert on the calls to update_or_create(), for example.

Add mechanism to handle dependency updates

The third-party dependencies are currently pinned to what their latest version was when this project started.

When they release a new version, we need to know about it, check the release notes and the code changes, and update requirements.txt.

Look into Renovate.