tiararodney/psconfluencepublisher
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactor: adapt to nuspec requirement for gallery publishing

Browse source
This commit is contained in:
Rodweil, Theodor 2023-08-07 03:45:19 +02:00
parent 2019f8c959
commit 69c2684ee7
No known key found for this signature in database
GPG key ID: F8BC1B0EB1F9CCF5
29 changed files with 84 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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'"``