Allow publishing only on release
Opened this issue · 3 comments
I often make changes to the documentation that are only available with the next release. It would be nice if there was an option to only update the live website when a non-preview release is published.
I believe GitHub actions support this as a trigger:
on:
release:
types: [released] # as opposed to [prereleased]Yeah, what i meant was to ask for making this a CLI option to avoid having to edit the autogenerated action manually.
I think this is definitely something we should offer as config and auto-generate! I think @shadows-withal was sharing in the hopes of unblocking you asap until we can add/release the feature :)
As an aside: From my own personal experience with projects like wasm-pack the cadence on updating the docs/marketing sites can be complicated- as people will come to fix typos, etc, that are already fixed, just not yet released (and sometimes that person is you, heh!). For wasm-pack we ended up shipping both "released" and "from main" docs (NB the warning at the top) to try to strike a balance, which I don't think we were ever fully happy with. In cargo-dist, we add a "since X.X.X" (e.g. https://opensource.axo.dev/cargo-dist/book/installers/homebrew.html) to indicate versions. I definitely think that oranda should be flexible and allow users to config this, but I thought I might share the complexities I've run into which led us to the current behavior.