Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow publishing only on release #646

Open
konstin opened this issue Sep 29, 2023 · 3 comments
Open

Allow publishing only on release #646

konstin opened this issue Sep 29, 2023 · 3 comments

Comments

@konstin
Copy link

konstin commented Sep 29, 2023

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.

@shadows-withal
Copy link
Contributor

I believe GitHub actions support this as a trigger:

on:
  release:
    types: [released] # as opposed to [prereleased]

@konstin
Copy link
Author

konstin commented Oct 1, 2023

Yeah, what i meant was to ask for making this a CLI option to avoid having to edit the autogenerated action manually.

@ashleygwilliams
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants