Ansible Semaphore integration

[fiftin]

Description

Hi, I'm maintainer of Semaphore,

Is it possible to add integration with Semaphore to Homepage? What required from me? Thank you.

Other

No response

[glime-ai[bot]]

Thanks for posting a discussion about homepage here on GitHub. Homepage now uses a fancy new AI tool thanks to our friends at Glime, so the answer below is the AI bot's attempt to answer your question. If you feel it's sufficient you can mark the answer and close this post, otherwise feel free to leave it open of course!

Thanks for using Homepage! ❤️

---

Hello,

To integrate Semaphore with Homepage, you would need to create a service widget that can interact with Semaphore's API or any other interfaces it provides. Here are the steps you should follow:

1. Familiarize with Homepage's Development Guidelines: Review the development guidelines provided in the Homepage documentation to understand how to set up your development environment and the project's coding standards. This includes setting up pre-commit hooks for code formatting and linting.

2. Understand Service Widget Guidelines: Make sure to read the specific guidelines for creating new service widgets. This will include how to structure your widget, the coding standards, and any specific requirements that Homepage has for integrating new services.

3. Develop the Widget: Develop the widget using the information you've gathered. Since Homepage is a Next.js application, you'll likely be writing your widget in JavaScript or TypeScript. Ensure that your widget can communicate with Semaphore's API to fetch and display the necessary information.

4. Test Your Widget: Thoroughly test your widget to ensure it works as expected and handles errors gracefully.

5. Contribute Your Widget: Once your widget is ready, you can contribute it to the Homepage project by following the contribution process outlined in the CONTRIBUTING.md file. This will typically involve forking the repository, making your changes, and then submitting a pull request.

6. License Agreement: Be aware that any contributions you make will be under the GNU General Public License v3.0, as stated in the project's contributing guidelines.

7. Open a Discussion: If you have ideas for a larger feature or are unsure about any aspect of the integration, open a discussion on the project's GitHub or Crowdin page to get feedback from the maintainers and community.

8. Follow Up: After submitting your contribution, keep an eye on your pull request for any feedback from the project maintainers. You may need to make revisions based on their suggestions.

If you need any specific help or have questions during the process, feel free to reach out to the Homepage maintainers through the appropriate channels, such as GitHub discussions.

Would you like to proceed with this, or do you need further assistance on any specific step?

This comment was generated by Glime.

[RoboMagus]

As I've been recently playing with Semaphore myself I'm interested in this as well. But I'm wondering what kind of information would be useful for showing in widgets?

Number of projects, users, templates, jobs (total or running), failed / succeeded tasks?
Mostly the latter would sound interesting to me, but how to scope this? As a selection between templates / projects / total?

While I'd like to see services such as Homepage hook into the Ansible Semaphore API, currently it seems that the state of its API is a bit messy. The docs appear to be out of sync with the latest release. I've found cases where documentation is incomplete w.r.t. what endpoints are exposed, and in other places there are inconsistencies about the data structures (both required inputs and what is returned).
Until the docs completely match the implemented API (and ideally are actively verified by e.g. unit tests) the stability of the API is not guaranteed and IMO not something that can reliably be built upon.

[github-actions[bot]]

This discussion has been automatically closed due to lack of community support. See our contributing guidelines for more details.

[e36Alex]

I would like to see a semaphore widget, too.
Helpful informations for me would be successful and failed jobs in the last 24h, for example.