ponylang / main.actor.archived

https://www.main.actor
6 stars 5 forks source link

Allow for PRs to validate changes without updating docs #3

Closed SeanTAllen closed 5 years ago

SeanTAllen commented 6 years ago

Currently, there's no way to have a CI tasks that generates missing docs without checking in the results. This makes it hard to test that changes work correctly.

I see this as a 2 step thing to tackle:

Step 1:

Step 2:

SeanTAllen commented 6 years ago

Currently, opening a PR for a new manifest, it will result in the docs from that PR being built. So the PR gets opened. It gets run, additional commits for the docs are added. Example:

screenshot 2018-10-20 19 12 40

If CI auto-cancellations are on, this results in weird things like the build of some docs being deleted.

It's an interesting idea to have docs built during the PR, then we can see what the final documentation would look like and the end user could spot troubles.

Because this is what we have right now, I'm turning off CircleCI auto-cancellations for this repo.

SeanTAllen commented 5 years ago

This is no longer applicable given the recent architecture changes.

See https://gist.github.com/SeanTAllen/1ecefb51c606c1a5b5b278b89aa49f4e for more information.