diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index e6e1914..3bc0f9b 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-09-27T07:25:37","documenter_version":"1.0.1"}} \ No newline at end of file +{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-09-27T07:49:42","documenter_version":"1.0.1"}} \ No newline at end of file diff --git a/dev/index.html b/dev/index.html index a965ac6..c697d14 100644 --- a/dev/index.html +++ b/dev/index.html @@ -15,4 +15,4 @@ If you pass a 0, it has a special meaning. -CI_INTG_PKG_URL_DEP1JL: https://github.com/user1/dep1.jl#45a723b
It is also possible to set a custom URL for more than one package, which depends on orig
. Simple add an additional line with the shape of CI_INTG_PKG_URL_<dep_name>: https://github.com/<user>/<dep_name>#<commit_hash>
to the commit message.
You don't need to add a new commit to set custom URLs. You can modify the commit message with git commit --amend
and force push to the branch. This also starts the CI pipeline again.
This section explains how the integration tests are created and executed. It is not mandatory to read the section if you only want to use the CI. The following figure shows the stages of the CI pipeline:
All of the following stages are executed in the CI pipeline of the sub-package, where the code is modified. This means also, that GitLab CI automatically checks out the repository with the changes of the pull request and provides it in the CI job. We name the package orig
for easier understanding of the documentation.
orig
via Pkg.test()
.jobGenerator.jl
script from the QED.jl
package via git clone
. The script is executed with the name of the subpackage orig
. The script traverses the dependency tree of the QED.jl
and it is searching for sub-packages which has a dependency of package orig
. For each package with the dependency of package orig
, the generator generates a job yaml. By default, it uses the upstream repository and development branch of the package tested in the integration test. The repository and commit can be changed via the environment parameter in the git commit message. The jobGenerator.jl
uses the Package.toml
of the QED.jl
package because all sub-packages are direct and indirect dependencies of it.Pkg.develop(path="$CI_package_DIR")
to replace the dependency to the package orig
with the modified version of the Pull Request and execute the tests of the subpackage via Pkg.test()
.If a sub package triggers an integration test, the main package QED.jl
is passive. It does not get any notification or trigger any script. The repository is simply cloned.
Settings
This document was generated with Documenter.jl version 1.0.1 on Wednesday 27 September 2023. Using Julia version 1.9.3.