don't run docsgen on main branch merges or releases #81
Conversation
There was a problem hiding this comment.
I would be inclined not to make this change: this doesn't actually solve the problem, it just hides it.
The invariant which we should be trying to maintain is that the main branch never needs documentation updates. If we could do that, then there would be no point to running docsgen on the main branch (release branches are a different, somewhat more interesting question). But, just because there shouldn't be any point doesn't mean that we shouldn't run it anyway: it's like any other part of the CI test system -- we want to know when the invariant ends up being violated.
Currently, if the main branch manages, by whatever process, to become out of date, we will find out when docsgen tries to update it. Granted, the indication of this is an ungraceful failure, but that is what we should be addressing, rather than trying to prevent it from detecting the change at all.
|
Closing based on discussion |
Changes introduced with this PR
Don't run docsgen on main or releases. Eliminates the unnecessary time and resources in the workflow process, and corrects an error condition that can happen in a merge race.
By contributing to this repository, I agree to the contribution guidelines.