Skip to content

Commit

Permalink
Add some information about the key4hep build workflow / action
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcarcell committed Mar 28, 2024
1 parent 7ce5e68 commit 4897510
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# key4hep-actions
Github actions for CI in the key4hep stack

# Key4hep build
This action builds the Key4hep stack on the supported OSes for both the stable
releases and the nightlies. After that, it runs the available tests using
`ctest`. It also runs during the night every day to populate a cache (using
`ccache`) that is later used by the action (for example, in pull requests) so
that building will be faster if they files that are built haven't changed. For
example, for a simple change in a README file the builds will be very fast since
all the files are cached, but the workflow may take longer because of the tests.

# Downstream build
This action does two things:
- Builds packages downstream to check that the changes that were made do not
Expand Down

0 comments on commit 4897510

Please sign in to comment.