[{"_1":2,"_167":-5,"_168":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_142":143},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_135":-5,"_136":11,"_137":17,"_138":11,"_139":-5,"_140":141},"canonicalUrl","https://hub.docker.com/r/braedon/github-tweeter/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","braedon","reponame","github-tweeter","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2019-11-06T14:43:16.498924Z","description","A simple bot to announce Github releases on Twitter","is_private","last_updated","2020-09-09T04:26:44.480946Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",625,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Github Tweeter\n\nA simple bot that listens to `release` type event webhooks from Github, and tweets about `published` releases.\n\n[Source Code](https://github.com/braedon/github-tweeter) | [Docker Image](https://hub.docker.com/r/braedon/github-tweeter)\n\n## How To Deploy\n\n### 1. Twitter Setup\n\nTo allow Github Tweeter to tweet as you, you'll need to create a Twitter app. This requires a Twitter developer account - I'll leave that as an exercise for the reader. Once you have a developer account, go to https://developer.twitter.com/en/apps and `Create an app`. Fill in all the required fields appropriately - all optional fields can be left blank - and `Create` the app.\n\nOnce created, go to the `Keys and tokens` tab of the app settings. Generate an access token, and then take note of the `Access token & access token secret`, and `Consumer API keys`. You'll need them to configure Github Tweeter in the next step.\n\n### 2. Github Tweeter Deployment\n\nGithub Tweeter serves a REST endpoint at `/webhook` (on port `8080` by default), which needs to be deployed to a public URL (e.g. https://example.com/github-tweeter/webhook) on the hosting of your choice. This is the endpoint that Github will send event webhooks to.\n\nYou will need to configure Github Tweeter with the various keys and secrets from the Twitter app created in the previous step.\n\nIt also needs a shared secret that Github will use to sign the webhooks it sends. You can generate this however you like, but it should be long and random. Take note of it for the next step.\n\nGithub Tweeter can be run directly from source, though this isn't recommended for production deployments.\n\n```\n> pip3 install -r requirements.txt\n> python3 main.py -h\nUsage: main.py [OPTIONS]\n\nOptions:\n --github-webhook-secret TEXT Github webhook secret. [required]\n --twitter-consumer-key TEXT Twitter consumer API key. [required]\n --twitter-consumer-secret TEXT Twitter consumer API secret key. [required]\n --twitter-token-key TEXT Twitter access token. [required]\n --twitter-token-secret TEXT Twitter access token secret. [required]\n -p, --port INTEGER Port to serve API on (default=8080).\n -j, --json Log in json.\n -v, --verbose Log debug messages.\n -h, --help Show this message and exit.\n> python3 main.py \\\n --github-webhook-secret \\\n --twitter-consumer-key \\\n --twitter-consumer-secret \\\n --twitter-token-key \\\n --twitter-token-secret \n```\n\nFor production deployments, using the provided [docker image](https://hub.docker.com/repository/docker/braedon/github-tweeter) is recommended, as is using environment variables to provide the various keys and secrets.\n\n```\n> sudo docker run --rm --name github-tweeter \\\n -e GITHUB_TWEETER_OPT_GITHUB_WEBHOOK_SECRET= \\\n -e GITHUB_TWEETER_OPT_TWITTER_CONSUMER_KEY= \\\n -e GITHUB_TWEETER_OPT_TWITTER_CONSUMER_SECRET= \\\n -e GITHUB_TWEETER_OPT_TWITTER_TOKEN_KEY= \\\n -e GITHUB_TWEETER_OPT_TWITTER_TOKEN_SECRET= \\\n braedon/github-tweeter:\n```\n\n### 3. Github Setup\n\nTo connect a Github repository, configure a webhook (`Settings` -> `Webhooks` -> `Add webhook`) with the following settings:\n\n- **Payload URL:** https://example.com/github-tweeter/webhook\n- **Content type:** `application/json`\n- **Secret:** The Github webhook secret you generated earlier.\n- **Which events would you like...:** Select `Let me select individual events.` and check `Releases`. Uncheck everything else.\n\nNote that when you initially add a webhook Github will send a `ping` type event. If you've already deployed Github Tweeter, it will log a warning that it has received an unknown event type - this is safe to ignore.\n\n### 4. Create a Release\n\nAssuming everything is setup correctly, the next time you create a release - a full Github release, not a git tag - Github Tweeter will post a tweet from your account announcing the release, and linking to the release on Github.\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",226264408,"orgData","recentTags",[87,125],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",835487,"full_size",84320308,"id",116560466,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:71bf6abd9c6f6564067f89a0f016ba4500f2f34ec3de54c8b25ff90499c65f92","features","","last_pulled","2026-09-14T12:09:37.404319977Z","last_pushed","2020-09-09T04:26:45Z","os","linux","os_features","os_version","size","variant","2020-09-09T04:26:44.103565Z","last_updater","last_updater_username","media_type","0.2.0","repository",7974118,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_88":40,"_89":90,"_91":126,"_93":127,"_95":128,"_46":133,"_115":90,"_116":29,"_117":52,"_53":134,"_119":120,"_121":131,"_122":133,"_123":62,"_124":17},100232874,75276873,[129],{"_98":99,"_100":130,"_102":103,"_104":131,"_106":132,"_108":109,"_110":103,"_111":-5,"_112":126,"_59":62,"_113":-5},"sha256:be8f24c115bd91dcfdbd4df3e7489af5557216d991092ff793e4d046254a52e5","2026-09-12T01:29:10.311615758Z","2019-11-06T14:48:16Z","2019-11-06T14:48:15.19186Z","0.1.0","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":144,"_151":152,"_140":165,"_166":11},{"_36":145,"_38":146,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":147,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":148,"_75":11,"_76":150,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":149},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_153":154,"_155":-5,"_156":-5,"_157":158},"count",2,"next","previous","results",[159,162],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":160,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[161],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},{"_88":40,"_89":90,"_91":126,"_93":127,"_95":163,"_46":133,"_115":90,"_116":29,"_117":52,"_53":134,"_119":120,"_121":131,"_122":133,"_123":62,"_124":17},[164],{"_98":99,"_100":130,"_102":103,"_104":131,"_106":132,"_108":109,"_110":103,"_111":-5,"_112":126,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

braedon/github-tweeter

Tags for braedon/github-tweeter