homothetyhk / HollowKnight.ItemChanger

A Hollow Knight mod for editing and adding items
GNU Lesser General Public License v2.1
15 stars 12 forks source link

Update readme with link to pages docs, add workflow to rebuild docs on release #10

Closed BadMagic100 closed 2 years ago

BadMagic100 commented 2 years ago

Bit overdue on my part - due to quirks of gh actions changes on the master branch will not trigger workflows on the docs-source branch so it needs to be defined here as well. Good news is, we can have different triggers.

I've set this up to rebuild docs either on-demand or when a release is published. If you wanted you could replace L4-5 with

  push:
    branches: [ master, docs-source ]

similar to on the docs-source branch. This would automatically rebuild docs every commit which could be desirable but in theory may make the docs a bit unstable and ahead of the released library. Your call how much you care :)