Skip to content
This repository has been archived by the owner on Sep 27, 2023. It is now read-only.

Latest commit

 

History

History
51 lines (30 loc) · 3.33 KB

README.md

File metadata and controls

51 lines (30 loc) · 3.33 KB
Raw

Kubernetes Contributor Tweets

Welcome to Contributor Tweets!

This repository is part of the automation, to tweet from the K8sContributors twitter account. If you are looking at posting a tweet from the K8sContributors account, please follow the instructions below.

This project is currently owned and maintained by the SIG Contribex Contributor Comms Team.

Automation

The automation is based on twitter-together project.

twitter-together is a GitHub Action that utilizes text files to publish tweets from a GitHub repository. Rather than tweeting directly, GitHub’s pull request review process encourages more collaboration, Twitter activity and editorial contributions by enabling everyone to submit tweet drafts to a project

Everytime a PR with a new .tweet file gets merged, the contents of the file will used to send out a tweet instantly from the K8sContributors account.

The automation also supports tweet scheduling with the help of merge-schedule-action. To schedule a tweet for a specific day, enter the command \schedule yyyy-mm-dd in the PR description. This will tweet on the given day at 12 AM GMT.

Note: The schedule feature is not supported for PR from fork repos. Therefore, this feature should be investigated further and should be used with caution

Thanks to the team behind twitter-together for putting together a wonderful open-source project.

Posting a new tweet

  1. Create a new issue in this repository.
  2. Follow the issue template and fill in the prompts.
  3. Click submit.
  4. If you have exceeded the maximum length, you will be thrown with an error comment. Please fix and comment /validate on the issue to restart the automation process.
  5. If everything is fine, you will be given a pull request link in the issue.
  6. Once the PR is approved and merged, the tweet is sent out from the K8sContributors account

Notes

  • Only newly created files are handled, deletions, updates or renames are ignored.
  • *.tweet files will not be created for tweets sent out directly from twitter.com
  • If you need to rename an existing tweet file, please do so locally using git mv old_filename new_filename, otherwise it may occur as deleted and added which would trigger a new tweet.

Contribute

We are always looking for people to help us improve the automation. Look at our contributing guide to get started.

Please feel free to join our weekly meetings or reach out to the maintainers of this project.

For adding features to the Github actions, we encourage to make upstream contributions to the twitter-together project and then use the new feature downstream here.

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.