diff --git a/.nuspec b/.nuspec deleted file mode 100755 index 6e7a6a3..0000000 --- a/.nuspec +++ /dev/null @@ -1,14 +0,0 @@ - - - - ConfluencePublisher - 1.1.0 - Übergangslösung für die Integration von sphinx-confluencebuilder generierter Confluence Dokumentation - tiara.rodney@adesso.de - irina.ternovykh@vkb.de - UNLICENSED - README.md - VKBit Betrieb GmbH - Powershell Confluence Publisher - - diff --git a/PSConfluencePublisher.nuspec b/PSConfluencePublisher.nuspec new file mode 100755 index 0000000..e7d0244 --- /dev/null +++ b/PSConfluencePublisher.nuspec @@ -0,0 +1,14 @@ + + + + PSConfluencePublisher + 1.1.0 + standalone publisher for xconfluencebuilder + theodor.rodweil@victory-k.it + Theodor Rodweil + DL-DE-BY-2.0 + README.md + Victory Karma IT + Powershell Confluence Publisher + + diff --git a/README.md b/README.md index 657a20e..002b979 100755 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # PSConfluencePublisher This program is a standalone publisher component for the -`sphinxcontrib.confluencebuilder` Sphinx extension. +[victorykit-xconfluencebuilder](https://bitbucket.org/victorykit/xconfluencebuilder) +Sphinx extension. It consumes, a JSON-formatted manifest of a *Sphinx build* dump generated by the ``sphinxcontrib.xconfluencebuilder`` and unidirectionally synchronizes @@ -24,11 +25,12 @@ to reduce the amount of remote data retrieval. This includes hashing of page and attachments content in addition to tracking publishing versions and remote ids. Through a JSONSchema, it is made sure that the manifest stays consistent for interchange with the original manifest producer system -(```sphinxcontrib.xconfluencebuilder``). +(`victorykit-xconfluencebuilder`). ## Usage -You can install the module via [nuget](https://www.nuget.org). +You will be able to install the module via [nuget](https://www.nuget.org). This +however is not yet possible. ``` Install-Module victorykit.PSConfluencePublisher @@ -45,7 +47,7 @@ PS> git clone git@bitbucket.org:victorykit/psconfluencepublisher.git ``` PS> # universal import statement compatible with PowerShell Core & Desktop -PS> Import-Module (Join-Path 'PSConfluencePublisher' +PS> Import-Module (Join-Path 'tools' 'PSConfluencePublisher.psd1') ``` @@ -102,9 +104,9 @@ This program requires [Pester](https://pester.dev/) to execute it's test suite. You can execute the following from within a PowerShell session. -``PS> Invoke-Pester PSConfluencePublisher/*.Tests.ps1 -Show 'All'`` +``PS> Invoke-Pester tools/*.Tests.ps1 -Show 'All'`` or the following, from within a POSIX shell and PowerShell Core being present: -``$ pwsh -c "Invoke-Pester PSConfluencePublisher/*.Tests.ps1 -Show 'All'"`` +``$ pwsh -c "Invoke-Pester tools/*.Tests.ps1 -Show 'All'"`` diff --git a/samples/default/confluence.out/._.DS_Store b/samples/default/confluence.out/._.DS_Store new file mode 100755 index 0000000..9ad849c Binary files /dev/null and b/samples/default/confluence.out/._.DS_Store differ diff --git a/samples/default/confluence.out/._manifest.json b/samples/default/confluence.out/._manifest.json new file mode 100755 index 0000000..9562bff Binary files /dev/null and b/samples/default/confluence.out/._manifest.json differ diff --git a/samples/default/confluence.out/attachments/._pexels-just-a-couple-photos-3777622.jpg b/samples/default/confluence.out/attachments/._pexels-just-a-couple-photos-3777622.jpg new file mode 100755 index 0000000..e739966 Binary files /dev/null and b/samples/default/confluence.out/attachments/._pexels-just-a-couple-photos-3777622.jpg differ diff --git a/samples/default/confluence.out/attachments/._pexels-sami-aksu-14356302.jpg b/samples/default/confluence.out/attachments/._pexels-sami-aksu-14356302.jpg new file mode 100755 index 0000000..256fee8 Binary files /dev/null and b/samples/default/confluence.out/attachments/._pexels-sami-aksu-14356302.jpg differ diff --git a/samples/default/confluence.out/attachments/objects.inv b/samples/default/confluence.out/attachments/objects.inv new file mode 100755 index 0000000..5f22d35 Binary files /dev/null and b/samples/default/confluence.out/attachments/objects.inv differ diff --git a/samples/default/confluence.out/attachments/pexels-just-a-couple-photos-3777622.jpg b/samples/default/confluence.out/attachments/pexels-just-a-couple-photos-3777622.jpg new file mode 100755 index 0000000..2f8d125 Binary files /dev/null and b/samples/default/confluence.out/attachments/pexels-just-a-couple-photos-3777622.jpg differ diff --git a/samples/default/confluence.out/attachments/pexels-sami-aksu-14356302.jpg b/samples/default/confluence.out/attachments/pexels-sami-aksu-14356302.jpg new file mode 100755 index 0000000..477e0a8 Binary files /dev/null and b/samples/default/confluence.out/attachments/pexels-sami-aksu-14356302.jpg differ diff --git a/samples/default/confluence.out/manifest.json b/samples/default/confluence.out/manifest.json new file mode 100755 index 0000000..fb8ded8 --- /dev/null +++ b/samples/default/confluence.out/manifest.json @@ -0,0 +1,33 @@ +{ + "Pages": [ + { + "Title": "Default Sample~", + "Ref": "pages/Default+Sample~.xml" + }, + { + "Title": "Cats", + "Ref": "pages/Cats.xml", + "AncestorTitle": "Default Sample~" + } + ], + "Attachments": [ + { + "Name": "pexels-just-a-couple-photos-3777622.jpg", + "ContainerPageTitle": "Cats", + "MimeType": "image/jpeg", + "Ref": "attachments/pexels-just-a-couple-photos-3777622.jpg" + }, + { + "Name": "pexels-sami-aksu-14356302.jpg", + "ContainerPageTitle": "Cats", + "MimeType": "image/jpeg", + "Ref": "attachments/pexels-sami-aksu-14356302.jpg" + }, + { + "Name": "objects.inv", + "ContainerPageTitle": "Default Sample~", + "MimeType": "application/octet-stream", + "Ref": "attachments/objects.inv" + } + ] +} \ No newline at end of file diff --git a/samples/default/confluence.out/pages/Cats.xml b/samples/default/confluence.out/pages/Cats.xml new file mode 100755 index 0000000..7203f34 --- /dev/null +++ b/samples/default/confluence.out/pages/Cats.xml @@ -0,0 +1,5 @@ +

What can we say… They secretly rule the world.

+ +

photo by: https://www.pexels.com/@jacp/

+ +

photo by: https://www.pexels.com/@sami-aksu-48867324/

\ No newline at end of file diff --git a/samples/default/confluence.out/pages/Default+Sample~.xml b/samples/default/confluence.out/pages/Default+Sample~.xml new file mode 100755 index 0000000..afa14b6 --- /dev/null +++ b/samples/default/confluence.out/pages/Default+Sample~.xml @@ -0,0 +1,24 @@ + +

confluence_conf.py is not required, it’s just a helper module to be able to configure sphinxcontrib.confluencebuilder through environment variables.

+
+

To run this sample, pipenv is required.

First, install the venv by executing the following command from within the samples/default/ directory:

+python +false + + + +

To contain the virtual environment within the current directory, create an empty directory named .venv.

+
+

Afterwards, execute the following command:

+python +false + + +

The backend for the command can be inspected in Pipfile.

You should now have a directory

Important Content

+ diff --git a/PSConfluencePublisher/Connection.Tests.ps1 b/tools/Connection.Tests.ps1 similarity index 100% rename from PSConfluencePublisher/Connection.Tests.ps1 rename to tools/Connection.Tests.ps1 diff --git a/PSConfluencePublisher/Connection.psm1 b/tools/Connection.psm1 similarity index 100% rename from PSConfluencePublisher/Connection.psm1 rename to tools/Connection.psm1 diff --git a/PSConfluencePublisher/Manifest.Tests.ps1 b/tools/Manifest.Tests.ps1 similarity index 100% rename from PSConfluencePublisher/Manifest.Tests.ps1 rename to tools/Manifest.Tests.ps1 diff --git a/PSConfluencePublisher/Manifest.psm1 b/tools/Manifest.psm1 similarity index 100% rename from PSConfluencePublisher/Manifest.psm1 rename to tools/Manifest.psm1 diff --git a/PSConfluencePublisher/PSConfluencePublisher.psd1 b/tools/PSConfluencePublisher.psd1 similarity index 100% rename from PSConfluencePublisher/PSConfluencePublisher.psd1 rename to tools/PSConfluencePublisher.psd1 diff --git a/PSConfluencePublisher/PSConfluencePublisher.psm1 b/tools/PSConfluencePublisher.psm1 similarity index 100% rename from PSConfluencePublisher/PSConfluencePublisher.psm1 rename to tools/PSConfluencePublisher.psm1 diff --git a/PSConfluencePublisher/Page.Tests.ps1 b/tools/Page.Tests.ps1 similarity index 100% rename from PSConfluencePublisher/Page.Tests.ps1 rename to tools/Page.Tests.ps1 diff --git a/PSConfluencePublisher/Page.psm1 b/tools/Page.psm1 similarity index 100% rename from PSConfluencePublisher/Page.psm1 rename to tools/Page.psm1 diff --git a/PSConfluencePublisher/PageMeta.Tests.ps1 b/tools/PageMeta.Tests.ps1 similarity index 100% rename from PSConfluencePublisher/PageMeta.Tests.ps1 rename to tools/PageMeta.Tests.ps1 diff --git a/PSConfluencePublisher/PageMeta.psm1 b/tools/PageMeta.psm1 similarity index 100% rename from PSConfluencePublisher/PageMeta.psm1 rename to tools/PageMeta.psm1 diff --git a/PSConfluencePublisher/PersonalAccessToken.Tests.ps1 b/tools/PersonalAccessToken.Tests.ps1 similarity index 100% rename from PSConfluencePublisher/PersonalAccessToken.Tests.ps1 rename to tools/PersonalAccessToken.Tests.ps1 diff --git a/PSConfluencePublisher/PersonalAccessToken.psm1 b/tools/PersonalAccessToken.psm1 similarity index 100% rename from PSConfluencePublisher/PersonalAccessToken.psm1 rename to tools/PersonalAccessToken.psm1 diff --git a/PSConfluencePublisher/String.Tests.ps1 b/tools/String.Tests.ps1 similarity index 100% rename from PSConfluencePublisher/String.Tests.ps1 rename to tools/String.Tests.ps1 diff --git a/PSConfluencePublisher/String.psm1 b/tools/String.psm1 similarity index 100% rename from PSConfluencePublisher/String.psm1 rename to tools/String.psm1 diff --git a/PSConfluencePublisher/manifest.schema.json b/tools/manifest.schema.json similarity index 100% rename from PSConfluencePublisher/manifest.schema.json rename to tools/manifest.schema.json diff --git a/PSConfluencePublisher/scripts.deps.json b/tools/scripts.deps.json similarity index 100% rename from PSConfluencePublisher/scripts.deps.json rename to tools/scripts.deps.json