User Documentation for SCM/CI Workflow Integration and More

We don’t stop improving the integration between OBS and SCMs. We heard your feedback and created a section in our OBS user manual and redesigned the tokens UI, among other improvements you can read below.

To start integrating OBS with SCMs, just join the beta program.

We started off the continuous integration between OBS and GitHub/GitLab in May 2021, then made some improvements in June 2021. We introduced advanced features like reporting filters and support for self-hosted SCM together with a list of common pitfalls in July 2021 and in August 2021, we continued with two new steps and a UI for tokens. In September 2021, we supported more actions for pull/merge requests, improved the UI for tokens, and added support for push events and a rebuild step. In November 2021, we presented the user documentation and further improvements for the UI for tokens and workflow runs and more. We worked on UI and reporting improvements in February 2022, followed by a step to trigger services and the improvement of the error messages in April 2022. Afterwards, we clarified the separation between incoming webhooks and status reports in May 2022, then sharing tokens was made possible in June 2022. Later in July 2022, we added support for the SCM Bridge feature. Around September 2022, the feature was considered stable, so we enabled it for all the OBS users, but that wasn’t the end; later in September we reached the milestone of supporting Gitea on top of GitHub and GitLab. In December 2022 we introduced placeholder variables in addition to a customizable configuration file location. Later on we brought notifications for failed workflow runs, and now we introduced a new way of listing the events by multiple filter parameters

This feature is documented in the SCM/CI Workflow Integration chapter of the OBS User Guide.

User Documentation for SCM/CI Workflow Integration

Since we started to implement the SCM/CI Workflow Integration beta feature, we have been publishing a series of blog posts. Those posts contained the instructions to configure and use the feature. After several publications, it was hard to follow the instructions spread in so many pieces of information.

Now, we have gathered all these information pills and have presented them in a more readable way by creating a new section in our OBS manual: SCM/CI Workflow Integration

Be aware that this is still a beta feature, so its documentation could change in the future. Please, have a look and keep your feedback coming.

Redesign of the Tokens UI

The Tokens UI has been redesigned. This UI has not only improved in terms of responsiveness, it also allows you to name your tokens in order to easily identify them.

Futhermore, it also displays the last time each token was triggered.

List and edit tokens with name in the web UI
List and edit tokens with name in the web UI

And Much More

Apart from these visible UI changes, we also have improved the detection and the error reporting of invalid workflows configurations. This makes it easier to recognize possible pitfalls. Just check for the responses of the SCM webhooks.

How To Give Us Feedback

There are two ways to reach us:

Please note that we favor GitHub to gather feedback as it allows us to easily keep track of the discussions.