KosmosisDire / obsidian-webpage-export

Export html from single files, canvas pages, or whole vaults. Direct access to the exported HTML files allows you to publish your digital garden anywhere. Focuses on flexibility, features, and style parity.

https://docs.obsidianweb.net/

MIT License

693 stars 58 forks source link

Create Docker container to Publish publish notes automatically #430

Open spartacus04 opened 1 month ago

spartacus04 commented 1 month ago

Goals

[x] Create a docker container that automatically builds the files headlessly
[x] Allow container to export with last settings
[x] Allow container to export with custom settings
[x] Setup a github action to use the container
[x] Compatibility with future versions without publishing of container

What I did so far

Updated all dependencies
Created a Docker container that builds the plugin and exports the vault with latest files (supports mounting a custom config file)
Tweaked the plugin to allow this
Tweak publish github actions to build the Docker container and publish it to DockerHub (Need to setup DOCKER_USERNAME and DOCKER_TOKEN inside repository secrets)
Created a github action to allow automation of publishing

Related to

49 #140

spartacus04 commented 1 month ago

Almost ready, the docker container is exporting to HTML successfully, just need to finish the github action and test it a bit, then it'll be ready to be merged.

KosmosisDire commented 1 month ago

Amazing! Thank you so much for your work on this!

spartacus04 commented 1 month ago

Just finished this, just remember to setup the DOCKER_USERNAME and DOCKER_TOKEN secrets inside the repository settings. Once a new tag is published the github action will start working correctly.

Here's an example on how the github action works:

      - name: Obsidian Webpage Export Action
        id: obsidian-webpage-export
        uses: KosmosisDire/obsidian-webpage-export
        with:
          vault: ./ #defaults to .
          version: latest #optional
          config: config.json #optional

      - run: |
          echo "The export is available at ${{ steps.obsidian-webpage-export.outputs.output }}"

I would advise creating a new tag both for the stable and beta release.

KosmosisDire commented 1 month ago

Awesome, this is amazing. I am pretty busy atm but I'll try and take a look at getting this set up today

KosmosisDire commented 1 month ago

Hey, I am trying to test this outside of GitHub actions and it seems to all work but I can't get it to actually export specific files. I think the config.json is not being respected somehow, I assume the config.json is meant to be the settings (data.json) from the plugin. When I export I simply get an export as if no files were selected for export. I just get the lib folder and no .html files. Is the config.json being copied into the plugin directory correctly?

spartacus04 commented 3 weeks ago

Hey, sorry for the late response. I was pretty busy last week. I just pushed a fix to that.

I also remembered, I haven't tested this for the 1.8.1 version, just for the master branch. Since I made some changes to the plugin code itself, for it to work they must also be applied to the other branches.

KosmosisDire commented 3 weeks ago

Thanks I'll test it out again, as far as the other branches I can either copy over the changes or they will be applied when the branch is merged into master.