Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Iris
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Pierre Roux
Iris
Commits
e30b3031
Commit
e30b3031
authored
3 years ago
by
Ralf Jung
Browse files
Options
Downloads
Patches
Plain Diff
fix docs
parent
53d4a19f
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING.md
+10
-9
10 additions, 9 deletions
CONTRIBUTING.md
iris-bot
+1
-1
1 addition, 1 deletion
iris-bot
with
11 additions
and
10 deletions
CONTRIBUTING.md
+
10
−
9
View file @
e30b3031
...
...
@@ -80,28 +80,29 @@ regular `make -jN` before submitting an MR.
## How to test effects on reverse dependencies
The
`iris-bot`
script makes it easy to
t
est the effect of a branch on reverse
The
`iris-bot`
script makes it easy to
t
est the effect of a branch on reverse
dependencies. It can start tests ensuring they all still build, and it can do
comparative timing runs.
If you have suitable permissions, you can trigger these builds yourself.
But first, you need to do some setup: you need to create a GitLab access token
and set the
`GITLAB_TOKEN`
environment variable to it. Go to
<https://gitlab.mpi-sws.org/-/profile/personal_access_tokens>
, pick a suitable
name (such as "iris-bot"), select the "api" scope, and then click "Create
personal access token". Copy the value it shows and store it in some suitable
place
,
you will not be able to retrieve this value from GitLab in the future!
place
;
you will not be able to retrieve this value from GitLab in the future!
For example, you could create a
`.env`
file in your Iris clone containing:
```
export GITLAB_TOKEN=<your token here>
```
Then you can easily get the token back into the environment via
`. .env`
.
Once that setup is done, you can now use
`iris-bot`
.
Set at least one of
`IRIS_REV`
or
`STDPP_REV`
to control which branches of these
projects to build
against (default to default git branch).
`IRIS_REPO`
and
`STDPP_REPO`
can be used to
take branches from forks. Setting
`IRIS`
to
"user:branch" will use the given branch on that user's fork of Iris,
and
similar for
`STDPP`
Once that setup is done, you can now use
`iris-bot`
.
Set at least one of
`IRIS_REV`
or
`STDPP_REV`
to control which branches of these
projects to build
against (
they
default to
the
default git branch).
`IRIS_REPO`
and
`STDPP_REPO`
can be used to
control the repository in which the branch is situated. Setting
`IRIS`
to
"user:branch" will use the given branch on that user's fork of Iris,
and
similar for
`STDPP`
.
Supported commands:
-
`./iris-bot build [$filter]`
: Builds all reverse dependencies against the
...
...
@@ -116,7 +117,7 @@ Examples:
against
`myname/mybranch`
from the main Iris repository.
-
`IRIS=user:branch ./iris-bot build examples`
builds the [examples] against
the
`branch`
in
`user`
's fork of Iris.
-
`IRIS_REV=myname/mybranch ./iris-bot time examples`
measure the timing impact
-
`IRIS_REV=myname/mybranch ./iris-bot time examples`
measure
s
the timing impact
of
`myname/mybranch`
from the main Iris repository on the [examples].
[
examples
]:
https://gitlab.mpi-sws.org/iris/examples
This diff is collapsed.
Click to expand it.
iris-bot
+
1
−
1
View file @
e30b3031
...
...
@@ -8,7 +8,7 @@ from datetime import datetime, timezone
# do further test/analysis on a branch (usually an MR).
# Set the GITLAB_TOKEN environment variable to a GitLab access token.
# Set at least one of IRIS_REV or STDPP_REV to control which branches of these
# projects to build against (default to default git branch). IRIS_REPO and
# projects to build against (default
s
to default git branch). IRIS_REPO and
# STDPP_REPO can be used to take branches from forks. Setting IRIS to
# "user:branch" will use the given branch on that user's fork of Iris, and
# similar for STDPP.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment