{"id":19614320,"url":"https://github.com/fpapado/org-release-announcer-twitter","last_synced_at":"2025-04-28T01:32:04.301Z","repository":{"id":96505039,"uuid":"128537076","full_name":"fpapado/org-release-announcer-twitter","owner":"fpapado","description":":robot: :tada: GitHub App to announce releases to Twitter from an org or repo.","archived":false,"fork":false,"pushed_at":"2018-04-07T22:50:29.000Z","size":163,"stargazers_count":9,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T04:41:17.113Z","etag":null,"topics":["github","probot","twitter"],"latest_commit_sha":null,"homepage":"https://glitch.com/~release-announcer-twitter","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fpapado.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2018-04-07T14:38:40.000Z","updated_at":"2019-03-25T22:15:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"fef9aa2c-057a-44e2-88d7-101446f5bbc9","html_url":"https://github.com/fpapado/org-release-announcer-twitter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpapado%2Forg-release-announcer-twitter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpapado%2Forg-release-announcer-twitter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpapado%2Forg-release-announcer-twitter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fpapado%2Forg-release-announcer-twitter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fpapado","download_url":"https://codeload.github.com/fpapado/org-release-announcer-twitter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251233939,"owners_count":21556762,"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":["github","probot","twitter"],"created_at":"2024-11-11T10:51:07.543Z","updated_at":"2025-04-28T01:32:04.271Z","avatar_url":"https://github.com/fpapado.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# org-release-announcer-twitter\n\nA GitHub App built with [probot](https://github.com/probot/probot) that announces releases to Twitter from the organisation or repository where it is installed.\n\nThis app is intended to be self-hosted, see [how do I run this?](#how-do-i-run-this) for more details.\n\n[![demo](docs/demo.png)]()\n\n## Setup\n\n```sh\n# Install dependencies\nnpm install\n\n# Run the bot\nnpm start\n```\n\n## Organisation\nThe library lives under `lib/index.js`.\nIt allows you to plug in \"announcers\" of the form:\n```js\n{\n  announce: function(event)\n}\n```\nIn this case, the announcer posts things to Twitter. It is found under `lib/twitterAnnouncer.js`.\nThe root `index.js` is a sample app that links together the Twitter announcer and the app.\n\n## How do I run this?\n[You can find a more template-y version of this on Glitch](https://glitch.com/~release-announcer-twitter).\n\nSelf-hosting would be my recommendation; I certainly don't want access to your data, and you likely have specific requirements for how to announce things :)\n\n1) Fork/Clone/Copy this repository:\n```shell\ngit clone https://github.com/fpapado/org-release-announcer-twitter.git\n```\n[Degit is a good tool for this](https://github.com/Rich-Harris/degit)\n\n2) Make any customisations you want to `lib/twitterAnnouncer.js`.\n\n3) Copy `.env.example` to `.env`. Use those files as reference whenever `.env` and API Keys are mentioned in the docs below.\n\n3) See [https://botwiki.org/resource/tutorial/how-to-create-a-twitter-app/](https://probot.github.io/docs/deployment/) for how to create a Twitter App and get the API keys/secrets for it.\n\n4) See [Probot's docs](https://probot.github.io/docs/deployment/#create-the-github-app) about the permissions and specifics of setting up the  Github App.\nThis app requires these **Permissions \u0026 events** for the GitHub App:\n\n- Repository contents - **Read-only**\n- Repository metadata - **Read-only**\n  - [x] Check the box for **Release** events\n\n5) See [Probot's docs for deployment](https://probot.github.io/docs/deployment/#deploy-the-app) for deployment options. Remember to also set the Twitter environment variables (as mentioned above), in addition to the Github App ones that it specifies.\n\n## Testing\nRun the tests with npm:\n\n```sh\nnpm test\n```\n\n:warning: Note that this posts about the `org-release-announcer`. Refer to https://probot.github.io/docs/simulating-webhooks/ for how to generate your own fixtures, if needed. :warning:\n\nYou can also simulate a release event from the fixtures. By default, it prints the announcement to the console:\n\n```sh\nnpm run dryrun:simulate:release\n```\n\nIf you want to verify the Twitter integration, you would have to make a post of the fixture:\n\n```sh\nnpm run live:simulate:release\n```\n\n## Thanks and Inspiration\nCredits to the Glitch starter templates:\n\nFor Probot:\nhttps://glitch.com/~probot-hello-world\n\nFor Twitter:\nhttps://glitch.com/~twitterbot\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffpapado%2Forg-release-announcer-twitter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffpapado%2Forg-release-announcer-twitter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffpapado%2Forg-release-announcer-twitter/lists"}