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

docs: add documentation for Ginkgo-based GHA #26055

Merged
merged 1 commit into from Jun 12, 2023

Conversation

aanm
Copy link
Member

@aanm aanm commented Jun 9, 2023

This commit adds comprehensive documentation on how to use GitHub Actions for Ginkgo Workflows, how to run tests locally, and test a particular SHA using GitHub.

The docs were written on top of #26019. The PRs can be merged independently.

@aanm aanm added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/CI Continuous Integration testing issue or flake area/CI-improvement Topic or proposal to improve the Continuous Integration workflow release-note/ci This PR makes changes to the CI. labels Jun 9, 2023
@aanm aanm requested review from a team as code owners June 9, 2023 00:27
@aanm aanm requested review from nebril and zacharysarah June 9, 2023 00:27
@aanm aanm force-pushed the pr/update-documentation-ginkgo-actions branch from b213df8 to 30f046a Compare June 9, 2023 00:29
@aanm aanm requested review from qmonnet and removed request for zacharysarah June 9, 2023 00:35
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PRs can be merged independently.

I'd rather have these YAML files merged in before referencing them in the docs, for my part.

Nice work! I've got some comments below. Mostly minor items, however one concern is that we could probably integrate the new section for e2e tests better. I'd probably feel lost landing on the new version of the page if I were trying to get started with e2e tests, see more comments below.

Direct links to preview:

Documentation/contributing/testing/ci.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/ci.rst Show resolved Hide resolved
Documentation/contributing/testing/ci.rst Show resolved Hide resolved
Documentation/contributing/testing/ci.rst Show resolved Hide resolved
Documentation/contributing/testing/ci.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
@nbusseneau nbusseneau self-requested a review June 9, 2023 14:19
Copy link
Member Author

@aanm aanm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review Quentin!

Documentation/contributing/testing/ci.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/ci.rst Show resolved Hide resolved
Documentation/contributing/testing/ci.rst Show resolved Hide resolved
Documentation/contributing/testing/ci.rst Show resolved Hide resolved
Documentation/contributing/testing/ci.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
Documentation/contributing/testing/e2e.rst Outdated Show resolved Hide resolved
@aanm aanm force-pushed the pr/update-documentation-ginkgo-actions branch from 30f046a to 7670fb9 Compare June 9, 2023 22:20
@aanm aanm requested a review from qmonnet June 9, 2023 22:20
@aanm aanm force-pushed the pr/update-documentation-ginkgo-actions branch 3 times, most recently from c873253 to fb1eae9 Compare June 10, 2023 23:50
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like all items were addressed, thanks!

One more comment on the numbering for the list (see above), but looks all good otherwise, thanks a lot!

This commit adds comprehensive documentation on how to use GitHub Actions
for Ginkgo Workflows, how to run tests locally, and test a particular SHA
using GitHub.

Signed-off-by: André Martins <andre@cilium.io>
@aanm aanm force-pushed the pr/update-documentation-ginkgo-actions branch from fb1eae9 to b112828 Compare June 12, 2023 10:48
@qmonnet
Copy link
Member

qmonnet commented Jun 12, 2023

I note that #26019 has been merged, so we're good to go about referencing the new YAML files.

@aanm aanm merged commit c2c5ed3 into cilium:main Jun 12, 2023
37 checks passed
@aanm aanm deleted the pr/update-documentation-ginkgo-actions branch June 12, 2023 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/CI Continuous Integration testing issue or flake area/CI-improvement Topic or proposal to improve the Continuous Integration workflow area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/ci This PR makes changes to the CI.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants