search

sablier-labs / docs

Documentation and guides for Sablier
https://docs.sablier.com
GNU General Public License v3.0
16 stars 7 forks source link

CI warnings with branch configuration #29

Closed razgraf closed 1 year ago

razgraf commented 1 year ago

As per the on.workflow_dispatch documentation it looks like there's no branches options for it.

The IDE (probably because of the Github Actions extension) is warning about this incorrect configuration. Was there a reason for leaving this here? Maybe it was meant for the pull_request / push triggers?

Screenshot 2023-07-04 at 13 19 21
PaulRBerg commented 1 year ago

Good catch!

I keep the workflow_dispatch event as a just-in-case feature - it doesn't hurt to be able to run the main GitHub Action workflow manually, e.g. for debugging purposes.

But, as you've pointed out, the current syntax is wrong. It should be updated to this:

on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - "main"
razgraf commented 1 year ago

Actually, I think it's just the push and the workflow_dispatch that have to stay there. pull_request will re-deploy the docs every time we do a PR (which shouldn't happen) and override the official website. For example, right now, the docs.sablier.com deployment is the one from my PR not what's on main.

PaulRBerg commented 1 year ago

Yes, you're right. I'll remove the pull_request trigger event.

I was also wondering why docs.sablier.com was using the redesigned version.