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.

Sign up for GitHub

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

Jump to bottom

feat: documentation examples github action #315

Closed
wants to merge 34 commits into from
Closed

feat: documentation examples github action #315

wants to merge 34 commits into from

Conversation

ThibaultFy
Copy link
Member

@ThibaultFy ThibaultFy commented Jun 1, 2023 •
edited
Loading

Summary

Github actions to run the examples in subprocess and docker mode every night with a message left on substra-ci

Official PR is now on the substra-ci repository: https://github.com/owkin/substra-ci/pull/97

@linear
Copy link

linear bot commented Jun 1, 2023

FL-573 [Release] GA to test documentation examples

Context and user need:
To meliorate the release process, we want to test the doc example every night and not at each release

Functional spec:
For the doc, run all the examples (this will require to parametrize the example with the client mode)
Nightly slack message

Technical spec:
Parametrize client mode on examples
Actions to launch test every night.
Slack message on connect-ci

Acceptance criteria:
Nighlty test for documentation exmaple (subprocess + docker mode)

@ThibaultFy ThibaultFy force-pushed the thibaultfouqueray/fl-573-release-ga-to-test-documentation-examples branch from ca79563 to 8d4c36b Compare June 5, 2023 15:49
ThibaultFy added 28 commits June 6, 2023 14:25
@ThibaultFy
create workflow file
5a61da9 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
launch iris example
0520f57 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
launch iris example
4322221 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
launch all examples
ac68d8b 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
launch all examples
d3d8ddc 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
launch all examples
b453304 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
launch all examples
50250e1 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
launch all examples
a9bfd7b 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
slack report
cc503c5 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
8c95499 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
0a0e542 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
60eb49c 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
46ef7db 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
fd37220 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
84eb785 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
8131ded 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
9c146ce 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
851401a 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
d04937d 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
44836aa 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
6cc48c7 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
all in one script
b3cc6a4 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
from run to test
78a997f 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
refacto test_examples
fc1a55b 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
refacto test_examples
5292ae5 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
refacto test_examples
92158b8 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
refacto test_examples
795fbcf 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
refacto test_examples
cc73653 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
ThibaultFy added 4 commits June 6, 2023 14:25
@ThibaultFy
refacto test_examples
b84bb98 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
refacto test_examples
ef38749 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
test docker msg
a3db238 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
back to normal
938ac49 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy ThibaultFy force-pushed the thibaultfouqueray/fl-573-release-ga-to-test-documentation-examples branch from 3cbcc9f to 938ac49 Compare June 6, 2023 12:25
ThibaultFy added 2 commits June 6, 2023 18:16
@ThibaultFy
change when actions are run
ac12635 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
changelog
706cf5d 
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy ThibaultFy marked this pull request as ready for review June 6, 2023 16:19
@ThibaultFy ThibaultFy requested a review from a team as a code owner June 6, 2023 16:19
oleobal
oleobal reviewed Jun 7, 2023
View reviewed changes
CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Update Iris example with the changes implied by [SubstraFL #120](https://github.com/Substra/substrafl/pull/120) compute plan builder ([#313](https://github.com/Substra/substra-documentation/pull/313))
- Add caution for frontend cookies when several backends in local ([#308](https://github.com/Substra/substra-documentation/pull/308))
- Update Substra examples to use new `get_task_output_asset` Substra function ([#317](https://github.com/Substra/substra-documentation/pull/317))
- Add Github actions to run examples in subprocess and docker mode every night ([#315](https://github.com/Substra/substra-documentation/pull/315))
Copy link
Contributor

Choose a reason for hiding this comment

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

Are CI changes relevant to the changelog ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Ahah I knew you were going to ask :p I guess it can be interesting for contributors to now that new GA are available, but no strong opinion really...

oleobal
oleobal reviewed Jun 7, 2023
View reviewed changes
ci/send-slack-report.py
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we put this inside the CI repo instead of here, so we wouldn't have to duplicate these files?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sounds obvious now you said it... Of course. I opened a PR here https://github.com/owkin/substra-ci/pull/97

@linear
Copy link

linear bot commented Jun 8, 2023

FL-573 [Release] GA to test documentation examples

Context and user need:
To meliorate the release process, we want to test the doc example every night and not at each release

Functional spec:
For the doc, run all the examples (this will require to parametrize the example with the client mode)
Nightly slack message

Technical spec:
Parametrize client mode on examples
Actions to launch test every night.
Slack message on connect-ci

Acceptance criteria:
Nighlty test for documentation exmaple (subprocess + docker mode)

@ThibaultFy ThibaultFy closed this Jun 8, 2023
@SdgJlbl SdgJlbl deleted the thibaultfouqueray/fl-573-release-ga-to-test-documentation-examples branch July 18, 2023 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oleobal oleobal oleobal left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ThibaultFy @oleobal