allanger/mkdocs-with-confluence
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Activity

Update variable naming (#7)

Browse Source 
Co-authored-by: Nikolai Rodionov <nikolai.rodionov@grandcentrix.net>
Reviewed-on: https://git.badhouseplants.net/allanger/mkdocs-with-confluence/pulls/7
This commit is contained in:
Nikolai Rodionov 2023-02-28 10:42:32 +00:00
parent 36ae68be6b
commit 162cb4a1bb
4 changed files with 92 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -7,7 +7,7 @@ venv:
run_example: run_example:
@docker build -t mkdocs-example -f ./example/Dockerfile --build-arg JIRA_PASSWORD=$(shell sops --decrypt ./example/secret.yaml | yq '.JIRA_PASSWORD' ) . @docker build -t mkdocs-example -f ./example/Dockerfile --build-arg MKDOCS_TO_CONFLUENCE_PASSWORD=$(shell sops --decrypt ./example/secret.yaml | yq '.JIRA_PASSWORD' ) .
@docker run -p 8000:8000 mkdocs-example @docker run -p 8000:8000 mkdocs-example
lint: lint:

4
example/Dockerfile
View File

@ -9,9 +9,9 @@ RUN mkdir /out
RUN mv $(find /src/dist -maxdepth 1 -mindepth 1 -name '*tar.gz') /out/mkdocs_with_confluence.tar.gz RUN mv $(find /src/dist -maxdepth 1 -mindepth 1 -name '*tar.gz') /out/mkdocs_with_confluence.tar.gz
FROM BUILDER as common_builder FROM BUILDER as common_builder
ARG MKDOCS_TO_CONFLUENCE_PASSWORD
ENV MKDOCS_TO_CONFLUENCE=true ENV MKDOCS_TO_CONFLUENCE=true
ARG JIRA_PASSWORD ENV MKDOCS_TO_CONFLUENCE_PASSWORD=$MKDOCS_TO_CONFLUENCE_PASSWORD
ENV JIRA_PASSWORD=$JIRA_PASSWORD
RUN pip install mkdocs mkdocs-material RUN pip install mkdocs mkdocs-material
WORKDIR /src WORKDIR /src
COPY ./example /src COPY ./example /src

173
mkdocs_with_confluence/plugin.py
View File

@ -22,6 +22,7 @@ from pathlib import Path
ENABLE_ENV_VAR = "MKDOCS_TO_CONFLUENCE" ENABLE_ENV_VAR = "MKDOCS_TO_CONFLUENCE"
DRY_RUN_ENV_VAR = "MKDOCS_TO_CONFLUENCE_DRY_RUN" DRY_RUN_ENV_VAR = "MKDOCS_TO_CONFLUENCE_DRY_RUN"
TEMPLATE_BODY = "<p> TEMPLATE </p>" TEMPLATE_BODY = "<p> TEMPLATE </p>"
HEADER_WARNING = "‼️ This page is created automatically, all you changes will be overwritten during the next MKDocs deployment. Do not edit a page here ‼️" HEADER_WARNING = "‼️ This page is created automatically, all you changes will be overwritten during the next MKDocs deployment. Do not edit a page here ‼️"
SECTION_PAGE_CONTENT = "<p> It's just a Section Page </p>" SECTION_PAGE_CONTENT = "<p> It's just a Section Page </p>"
@ -45,8 +46,8 @@ class MkdocsWithConfluence(BasePlugin):
("host_url", config_options.Type(str, default=None)), ("host_url", config_options.Type(str, default=None)),
("space", config_options.Type(str, default=None)), ("space", config_options.Type(str, default=None)),
("parent_page_name", config_options.Type(str, default=None)), ("parent_page_name", config_options.Type(str, default=None)),
("username", config_options.Type(str, default=environ.get("JIRA_USERNAME", None))), ("username", config_options.Type(str, default=environ.get("MKDOCS_TO_CONFLUENCE_USER", None))),
("password", config_options.Type(str, default=environ.get("JIRA_PASSWORD", None))), ("password", config_options.Type(str, default=environ.get("MKDOCS_TO_CONFLUENCE_PASSWORD", None))),
("dryrun", config_options.Type(bool, default=False)), ("dryrun", config_options.Type(bool, default=False)),
("header_message", config_options.Type(str, default=None)), ("header_message", config_options.Type(str, default=None)),
("upstream_url", config_options.Type(str, default=None)), ("upstream_url", config_options.Type(str, default=None)),
@ -107,94 +108,96 @@ class MkdocsWithConfluence(BasePlugin):
def on_files(self, files, config): def on_files(self, files, config):
pages = files.documentation_pages() if self.enabled:
try: pages = files.documentation_pages()
self.flen = len(pages) try:
logger.debug(f"number of Files in directory tree: {self.flen}") self.flen = len(pages)
except 0: logger.debug(f"number of Files in directory tree: {self.flen}")
logger.error("no files found to be synced") except 0:
logger.error("no files found to be synced")
def on_page_markdown(self, markdown, page, config, files): def on_page_markdown(self, markdown, page, config, files):
# TODO: Modify pages here if self.enabled:
try:
self.session.auth = (self.config["username"], self.config["password"])
confluencePageName = page.url[0:-1]
#.replace("/", "-")
if self.config["parent_page_name"] is not None:
parent_page = self.config["parent_page_name"]
else:
parent_page = self.config["space"]
page_name = ""
# TODO: Refactor
if confluencePageName.rsplit('/',1)[0]:
confluencePageName = (f"{confluencePageName.rsplit('/',1)[0]}+{page.title.replace(' ', ' ')}")
else:
confluencePageName = (f"{page.title.replace(' ', ' ')}")
# Create empty pages for sections only
logger.info("preparing emtpy pages for sections")
for path in page.url.rsplit("/", 2)[0].split("/"):
logger.debug(f"path is {path}")
parent_id = self.find_page_id(parent_page)
if path:
if page_name:
page_name = page_name + " " + path
else:
page_name = path
logger.info(f"Will create a page {page_name} under the {parent_page}")
self.add_page(page_name, parent_id, SECTION_PAGE_CONTENT)
parent_page = page_name
parent_id = self.find_page_id(parent_page)
confluencePageName = parent_page + " " + page.title
new_markdown = markdown
# -- Adding an upstream url
if self.upstream_url:
new_markdown = f">Original page is here: {self.upstream_url}/{page.url}\n\n" + new_markdown
# -- Adding a header message
if self.header_message:
new_markdown = f">{self.header_message}\n\n" + new_markdown
# -- Adding a repo url
if self.repo_url:
new_markdown = f">You can edit documentation here: {self.repo_url}\n\n" + new_markdown
# -- Adding a header warning
new_markdown = f">{self.config['header_warning']}\n\n" + new_markdown
# -------------------------------------------------
# -- Sync attachments
# -------------------------------------------------
attachments = []
# -- TODO: support named picture
md_image_reg = "(?:[!]\[(?P<caption>.*?)\])\((?P<image>.*?)\)(?P<options>\{.*\})?"
try: try:
for match in re.finditer(md_image_reg, markdown): self.session.auth = (self.config["username"], self.config["password"])
# -- TODO: I'm sure it can be done better confluencePageName = page.url[0:-1]
attachment_path = "./docs" + match.group(2) #.replace("/", "-")
logger.info(f"found image: ./docs{match.group(2)}") if self.config["parent_page_name"] is not None:
images = re.search(md_image_reg, new_markdown) parent_page = self.config["parent_page_name"]
# -- TODO: Options maybe the reason why page is invalid, but I'm not sure about it yet else:
# new_markdown = new_markdown.replace(images.group("options"), "") parent_page = self.config["space"]
new_markdown = re.sub(md_image_reg, f"<p><ac:image><ri:attachment ri:filename=\"{os.path.basename(attachment_path)}\"/></ac:image></p>", new_markdown) page_name = ""
attachments.append(attachment_path)
except AttributeError as e: # TODO: Refactor
logger.warning(e) if confluencePageName.rsplit('/',1)[0]:
logger.debug(f"attachments: {attachments}") confluencePageName = (f"{confluencePageName.rsplit('/',1)[0]}+{page.title.replace(' ', ' ')}")
confluence_body = self.confluence_mistune(new_markdown) else:
self.add_page(confluencePageName, parent_id, confluence_body) confluencePageName = (f"{page.title.replace(' ', ' ')}")
if attachments: # Create empty pages for sections only
logger.debug(f"UPLOADING ATTACHMENTS TO CONFLUENCE FOR {page.title}, DETAILS:") logger.info("preparing emtpy pages for sections")
logger.debug(f"FILES: {attachments}") for path in page.url.rsplit("/", 2)[0].split("/"):
for attachment in attachments: logger.debug(f"path is {path}")
logger.debug(f"trying to upload {attachment} to {confluencePageName}") parent_id = self.find_page_id(parent_page)
if self.enabled: if path:
try: if page_name:
self.add_or_update_attachment(confluencePageName, attachment) page_name = page_name + " " + path
except Exception as Argument: else:
logger.warning(Argument) page_name = path
except Exception as exp: logger.info(f"Will create a page {page_name} under the {parent_page}")
logger.error(exp) self.add_page(page_name, parent_id, SECTION_PAGE_CONTENT)
return markdown parent_page = page_name
parent_id = self.find_page_id(parent_page)
confluencePageName = parent_page + " " + page.title
new_markdown = markdown
# -- Adding an upstream url
if self.upstream_url:
new_markdown = f">Original page is here: {self.upstream_url}/{page.url}\n\n" + new_markdown
# -- Adding a header message
if self.header_message:
new_markdown = f">{self.header_message}\n\n" + new_markdown
# -- Adding a repo url
if self.repo_url:
new_markdown = f">You can edit documentation here: {self.repo_url}\n\n" + new_markdown
# -- Adding a header warning
new_markdown = f">{self.config['header_warning']}\n\n" + new_markdown
# -------------------------------------------------
# -- Sync attachments
# -------------------------------------------------
attachments = []
# -- TODO: support named picture
md_image_reg = "(?:[!]\[(?P<caption>.*?)\])\((?P<image>.*?)\)(?P<options>\{.*\})?"
try:
for match in re.finditer(md_image_reg, markdown):
# -- TODO: I'm sure it can be done better
attachment_path = "./docs" + match.group(2)
logger.info(f"found image: ./docs{match.group(2)}")
images = re.search(md_image_reg, new_markdown)
# -- TODO: Options maybe the reason why page is invalid, but I'm not sure about it yet
# new_markdown = new_markdown.replace(images.group("options"), "")
new_markdown = re.sub(md_image_reg, f"<p><ac:image><ri:attachment ri:filename=\"{os.path.basename(attachment_path)}\"/></ac:image></p>", new_markdown)
attachments.append(attachment_path)
except AttributeError as e:
logger.warning(e)
logger.debug(f"attachments: {attachments}")
confluence_body = self.confluence_mistune(new_markdown)
self.add_page(confluencePageName, parent_id, confluence_body)
if attachments:
logger.debug(f"UPLOADING ATTACHMENTS TO CONFLUENCE FOR {page.title}, DETAILS:")
logger.debug(f"FILES: {attachments}")
for attachment in attachments:
logger.debug(f"trying to upload {attachment} to {confluencePageName}")
if self.enabled:
try:
self.add_or_update_attachment(confluencePageName, attachment)
except Exception as Argument:
logger.warning(Argument)
except Exception as exp:
logger.error(exp)
return markdown
def on_post_page(self, output, page, config): def on_post_page(self, output, page, config):
logger.info("The author was uploading images here, maybe there was a reason for that") if self.enabled:
logger.info("The author was uploading images here, maybe there was a reason for that")
def on_page_content(self, html, page, config, files): def on_page_content(self, html, page, config, files):
return html return html

2
pyproject.toml
View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "mkdocs-with-confluence" name = "mkdocs-with-confluence"
version = "0.3.1" version = "0.3.2"
description = "MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API" description = "MkDocs plugin for uploading markdown documentation to Confluence via Confluence REST API"
authors = ["Nikolai Rodionov <allanger@zohomail.com>"] authors = ["Nikolai Rodionov <allanger@zohomail.com>"]
readme = "README.md" readme = "README.md"