More documentation for setting up Continuous Integration
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 3.2k
- Forks
- 106
- Avg merge
- 6d 13h
- Merged PRs (30d)
- 1
Description
https://skip.tools/docs/faq/#ci
Can Skip frameworks be built and tested using continuous integration systems?
Skip framework projects contain built-in support for running parity tests for both the Swift and Kotlin sides of a project. These tests can be included in automated continuous integration workflows to ensure that the tests are always passing. We do this ourselves for the various Skip frameworks, such as the SkipLib Actions, which references our standard GitHub CI workflow.
The documentation here should at least link to https://github.com/skiptools/actions/ and https://github.com/skiptools/actions/tree/main/.github/workflows
I think I would remove the link to https://github.com/skiptools/skip-lib/actions. That's just a report of Github Action results. (I guess it's just a social proof, "see, wee use it, too" but I don't think the sort of person reading this answer needs that proof.)
It would also be great if skip init were to add example workflows.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the CI section at https://skip.tools/docs/faq/#ci and review the linked skiptools/actions workflows. Update the documentation with the requested workflow links, consider the suggested removal of the skip-lib Actions report link, and inspect the skip init entry point if adding example workflows is included; the relevant links and workflow guidance should be clear when done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, kotlin, swift
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100