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

Update CI documentation #2999

Merged
merged 1 commit into from
Jan 19, 2022
Merged

Update CI documentation #2999

merged 1 commit into from
Jan 19, 2022

Conversation

embg
Copy link
Contributor

@embg embg commented Jan 14, 2022

Travis CI has ended free usage for OSS. Additionally, the instructions for setting up Travis (and possibly the other services) are outdated. Since we have moved almost all of our CI onto Github Actions (which don't require any setup for forks), I think we should only require Github Actions to pass before submitting PRs against the main repo.

@Cyan4973
Copy link
Contributor

Looks fine for the general message,

but it seems we are missing an opportunity to educate our users.
The previous version of CONTRIBUTING.md was providing detailed instructions about how to subscribe to external CI services, in order to increase test coverage. In the proposed update, they are simply gone, with no replacement.

I could imagine that some of these instructions have become obsolete, and some CI may no longer be possible (TravisCI notably). But they are not all useless. We shouldn't go as far as discouraging users from adding other CI beyond Github Actions.

To counter the risk of obsolescence of local doc, try to find a documentation from the CI provider itself, and link to it.
The link might also die over time, though it's an acceptable limit to what it's reasonable to provide.

@embg embg force-pushed the ci_instructions_update branch from e915fdb to 72fefc8 Compare January 19, 2022 01:11
@embg embg force-pushed the ci_instructions_update branch from 72fefc8 to 8250faa Compare January 19, 2022 16:58
@embg embg merged commit 40bc9ee into facebook:dev Jan 19, 2022
@embg embg deleted the ci_instructions_update branch January 19, 2022 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants