Skip to content

[gitlab] Update documentation - GitLab bot setup#382

Open
sondrebr wants to merge 9 commits into
EESSI:gitlabfrom
sondrebr:add-gitlab-support-update-readme
Open

[gitlab] Update documentation - GitLab bot setup#382
sondrebr wants to merge 9 commits into
EESSI:gitlabfrom
sondrebr:add-gitlab-support-update-readme

Conversation

@sondrebr

@sondrebr sondrebr commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

This PR adds documentation for setting up the bot for GitLab (addressing issue #374).

Most of the changes are in the README, updating the prerequisites and adding GitLab-specific versions of steps 2, 3, and 5.1-5.3. I also renamed the original GitHub-specific steps to clearly differentiate between the GitHub and GitLab steps.
In step 4, I changed the minimum recommended Python version to Python 3.9. In step 5.4, I added the [git] and [gitlab] config sections, and made a few changes to the command_permission setting documentation (in app.cfg.example as well) to make it also apply to GitLab.

Comment thread README.md Outdated
- An event handler [`eessi_bot_event_handler.py`](eessi_bot_event_handler.py) which receives events from a GitHub repository or GitLab project and acts on them.
- A job manager [`eessi_bot_job_manager.py`](eessi_bot_job_manager.py) which monitors the Slurm job queue and acts on state changes of jobs submitted by the event handler.

Note that GitLab support is currently limited to the `help` command.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Let's make this jump out

Suggested change
Note that GitLab support is currently limited to the `help` command.
!!! warning "Limited feature support in GitLab"
Note that GitLab support is currently limited to the `help` command.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oh, sorry, this is not mkdocs!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think it is still important to bold this as it is pretty critical information

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Agreed: e6513ea

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants