{"id":28724119,"url":"https://github.com/processone/xmpp-notifier","last_synced_at":"2025-06-15T10:09:18.033Z","repository":{"id":64303331,"uuid":"243237793","full_name":"processone/xmpp-notifier","owner":"processone","description":"Github Action to send repository notifications to XMPP ","archived":false,"fork":false,"pushed_at":"2024-07-31T18:24:44.000Z","size":36,"stargazers_count":9,"open_issues_count":5,"forks_count":4,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-06-06T12:50:57.359Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/processone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-26T10:41:24.000Z","updated_at":"2024-10-18T07:48:56.000Z","dependencies_parsed_at":"2024-06-20T01:41:57.640Z","dependency_job_id":"8342bc48-018a-48f4-ae4a-4659cc23c16c","html_url":"https://github.com/processone/xmpp-notifier","commit_stats":{"total_commits":20,"total_committers":4,"mean_commits":5.0,"dds":0.4,"last_synced_commit":"63f9120194390db3283f89527b8f16e8bd8a3115"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/processone/xmpp-notifier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processone%2Fxmpp-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processone%2Fxmpp-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processone%2Fxmpp-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processone%2Fxmpp-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/processone","download_url":"https://codeload.github.com/processone/xmpp-notifier/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/processone%2Fxmpp-notifier/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259957280,"owners_count":22937549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-15T10:09:15.597Z","updated_at":"2025-06-15T10:09:18.024Z","avatar_url":"https://github.com/processone.png","language":"Go","readme":"# XMPP Notifier Action\nGithub action to notify xmpp users when some events occur on a given repository.  \n\nYou can either notify a single user or send a message to a channel.\n\n## List of parameters\nTo have more information on parameters this action can accept, please refer to the \n[action.yml file](https://github.com/processone/xmpp-notifier/blob/master/action.yml). \n\n\n## Main.yml\nThis file could be named as you wish, but has to be placed in the .github.workflows directory of your project.\nThis is an example for the main configuration that could be used to call the action :  \n```yaml\non:\n  # Specifies that we only want to trigger the following jobs on pushes and pull request creations for the master branch\n  push:\n    branches:\n      - master\n  pull_request:\n    branches:\n      - master\njobs:\n  notif-script:\n    runs-on: ubuntu-latest\n    name: job that pushes repo news to xmpp\n    steps:\n      - name: push_info_step\n        id: push\n        uses: processone/xmpp-notifier@master\n        # Will only trigger when a push is made to the master branch\n        if: github.event_name == 'push'\n        with: # Set the secrets as inputs\n          # jid expects the bot's bare jid (user@domain)\n          jid: ${{ secrets.jid }}\n          password: ${{ secrets.password }}\n          server_host: ${{ secrets.server_host }}\n          # Intended recipient of the notification such as a room or single user. Bare JID expected.\n          recipient: ${{ secrets.recipient }}\n          # Port is optional. Defaults to 5222\n          server_port: ${{ secrets.server_port }}\n          message: |\n            ${{ github.actor }} pushed ${{ github.event.ref }} ${{ github.event.compare }} with message:\n            ${{ join(github.event.commits.*.message) }}\n          # Boolean to indicate if correspondent should be treated as a room (true) or a single user (false)\n          recipient_is_room: true\n      - name: pr_open_info_step\n        id: pull_request_open\n        uses: processone/xmpp-notifier@master\n        # Will only get triggered when a pull request to master is created\n        if: github.event_name == 'pull_request' \u0026\u0026 github.event.action == 'opened'\n        with: # Set the secrets as inputs\n          jid: ${{ secrets.jid }}\n          password: ${{ secrets.password }}\n          server_host: ${{ secrets.server_host }}\n          recipient: ${{ secrets.recipient }}\n          message: |\n            ${{ github.actor }} opened a PR : ${{ github.event.pull_request.html_url }} with message :\n            ${{ github.event.pull_request.title }}\n          recipient_is_room: true\n      - name: pr_edit_info_step\n        id: pull_request_edit\n        uses: processone/xmpp-notifier@master\n        # Will only get triggered when a pull request to master is created\n        if: github.event_name == 'pull_request' \u0026\u0026 github.event.action == 'edited'\n        with: # Set the secrets as inputs\n          jid: ${{ secrets.jid }}\n          password: ${{ secrets.password }}\n          server_host: ${{ secrets.server_host }}\n          recipient: ${{ secrets.recipient }}\n          message: |\n            ${{ github.actor }} edited the following PR : ${{ github.event.pull_request.html_url }} with message :\n            ${{ github.event.pull_request.title }}\n          recipient_is_room: true\n``` \n\n## action.yml  \nThis file must be placed at the project root, and should not be renamed (see github actions documentation).  \nYou should not modify it because the go program relies on it.  \n\n## Dockerfile\nThe Dockerfile in this action is used to delpoy a docker container and run the go code that will notify users.  \n\n## entrypoint.sh\nUsed as the entry point of the docker container. Meaning this is executed when the docker container is started.  \nThis script uses inputs from the github action.\n\n## main.go\nA small go program that will be compiled and ran in the docker container when the github action is executed.  \nIt uses the [native go-xmpp library](https://github.com/FluuxIO/go-xmpp).\n\n## Example of configuration to trigger notifications on tests failure for a PR\n\n```yaml\njobs:\n  notif-script:\n    runs-on: ubuntu-latest\n    name: job that pushes test failures to xmpp\n    steps:\n      - name: Run tests\n        run: |\n          go test ./... -v -race\n      - name: Tests failed notif\n        if: failure()  \n        id: test_fail_notif\n        uses: processone/xmpp-notifier@master\n        with: # Set the secrets as inputs\n          # Login expects the bot's bare jid (user@domain)\n          jid: ${{ secrets.jid }}\n          password: ${{ secrets.password }}\n          server_host: ${{ secrets.server_host }}\n          # The intended recipient of the notification such as a xmpp room or a single user. Bare JID is expected\n          recipient: ${{ secrets.recipient }}\n          # Port is optional. Defaults to 5222\n          server_port: ${{ secrets.server_port }}\n          message: |\n            tests for the following PR have failed : ${{ github.event.pull_request.html_url }}\n          # Boolean to indicate if correspondent should be treated as a room (true) or a single user\n          recipient_is_room: true\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprocessone%2Fxmpp-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprocessone%2Fxmpp-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprocessone%2Fxmpp-notifier/lists"}