[RFE] Add social badges to all READMEs

[John15321]

Current situation

Most of the readmes do not yet have important links to socials etc in their READMEs

Impact

This will allow users to navigate out websites and socials as well as get in touch with us in a much easier way

Ideal future situation

All READMES have badges with socials, etc.

[sayanchowdhury]

Yes, Another place, I've planning to add is https://github.com/flatcar/.github/blob/main/profile/README.md -- this way our github profile page would also have information.

[John15321]

Here is a script I have been working on to try to automate that and do it for all of our repos at one (for starters I created a list):

#!/usr/bin/env bash
set -euo pipefail

# Replace these with the repositories you actually want to modify
REPOS=(
  "repo1"
  "repo2"
  "repo3"
)

# Lines for the badge snippet
BADGE_LINES=(
  "<div style=\"text-align: center\">"
  ""
  "[![Flatcar OS](https://img.shields.io/badge/Flatcar-Website-blue?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyNi4wLjMsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4wIiBpZD0ia2F0bWFuXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4Ig0KCSB2aWV3Qm94PSIwIDAgODAwIDYwMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgODAwIDYwMDsiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4NCgkuc3Qwe2ZpbGw6IzA5QkFDODt9DQo8L3N0eWxlPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQ0MCwxODIuOGgtMTUuOXYxNS45SDQ0MFYxODIuOHoiLz4NCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MDAuNSwzMTcuOWgtMzEuOXYxNS45aDMxLjlWMzE3Ljl6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNTQzLjgsMzE3LjlINTEydjE1LjloMzEuOVYzMTcuOXoiLz4NCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik02NTUuMiw0MjAuOXYtOTUuNGgtMTUuOXY5NS40aC0xNS45VjI2MmgtMzEuOVYxMzQuOEgyMDkuNFYyNjJoLTMxLjl2MTU5aC0xNS45di05NS40aC0xNnY5NS40aC0xNS45djMxLjINCgloMzEuOXYxNS44aDQ3Ljh2LTE1LjhoMTUuOXYxNS44SDI3M3YtMTUuOGgyNTQuOHYxNS44aDQ3Ljh2LTE1LjhoMTUuOXYxNS44aDQ3Ljh2LTE1LjhoMzEuOXYtMzEuMkg2NTUuMnogTTQ4Ny44LDE1MWg3OS42djMxLjgNCgloLTIzLjZ2NjMuNkg1MTJ2LTYzLjZoLTI0LjJMNDg3LjgsMTUxTDQ4Ny44LDE1MXogTTIzMywyMTQuNlYxNTFoNjMuN3YyMy41aC0zMS45djE1LjhoMzEuOXYyNC4yaC0zMS45djMxLjhIMjMzVjIxNC42eiBNMzA1LDMxNy45DQoJdjE1LjhoLTQ3Ljh2MzEuOEgzMDV2NDcuN2gtOTUuNVYyODYuMUgzMDVMMzA1LDMxNy45eiBNMzEyLjYsMjQ2LjRWMTUxaDMxLjl2NjMuNmgzMS45djMxLjhMMzEyLjYsMjQ2LjRMMzEyLjYsMjQ2LjRMMzEyLjYsMjQ2LjR6DQoJIE00NDguMywzMTcuOXY5NS40aC00Ny44di00Ny43aC0zMS45djQ3LjdoLTQ3LjhWMzAyaDE1Ljl2LTE1LjhoOTUuNVYzMDJoMTUuOUw0NDguMywzMTcuOXogTTQ0MCwyNDYuNHYtMzEuOGgtMTUuOXYzMS44aC0zMS45DQoJdi03OS41aDE1Ljl2LTE1LjhoNDcuOHYxNS44aDE1Ljl2NzkuNUg0NDB6IE01OTEuNiwzMTcuOXY0Ny43aC0xNS45djE1LjhoMTUuOXYzMS44aC00Ny44di0zMS43SDUyOHYtMTUuOGgtMTUuOXY0Ny43aC00Ny44VjI4Ni4xDQoJaDEyNy4zVjMxNy45eiIvPg0KPC9zdmc+DQo=)](https://www.flatcar.org/)"
  "[![Matrix](https://img.shields.io/badge/Matrix-Chat%20with%20us!-green?logo=matrix)](https://app.element.io/#/room/#flatcar:matrix.org)"
  "[![Twitter Follow](https://img.shields.io/twitter/follow/flatcar?style=social)](https://x.com/flatcar)"
  "[![Mastodon Follow](https://img.shields.io/badge/Mastodon-Follow-6364FF?logo=mastodon)](https://hachyderm.io/@flatcar)"
  "[![Bluesky](https://img.shields.io/badge/Bluesky-Follow-0285FF?logo=bluesky)](https://bsky.app/profile/flatcar.org)"
  ""
  "</div>"
)

BRANCH_NAME="add-badges-flatcar"
COMMIT_MESSAGE="Add badges to README"
PR_TITLE="Add badges to README"
PR_BODY="This PR prepends a set of Flatcar-related badges to the README."

for repo in "${REPOS[@]}"; do
  echo "==================================================================="
  echo "Updating repository: flatcar/${repo}"
  echo "==================================================================="

  # Clone the repo
  # https://cli.github.com/manual/gh_repo
  gh repo clone "flatcar/${repo}" -- -q
  cd "${repo}"

  # Get the default branch
  default_branch=$(gh repo view --json defaultBranchRef -q '.defaultBranchRef.name')
  echo "Default branch is: ${default_branch}"

  # Check out default branch & pull latest
  git checkout "${default_branch}"
  git pull origin "${default_branch}"

  # Create a new branch
  git checkout -b "${BRANCH_NAME}"

  # Prepend lines to README.md
  if [ -f README.md ]; then
    cp README.md README.md.bak
    {
      # Print each badge line
      for line in "${BADGE_LINES[@]}"; do
        echo "$line"
      done
      # Then append old content
      cat README.md.bak
    } > README.md
    rm README.md.bak
  else
    # If no README yet, just create one with badges
    for line in "${BADGE_LINES[@]}"; do
      echo "$line"
    done > README.md
  fi

  # Commit & push
  git add README.md
  git commit -m "${COMMIT_MESSAGE}"
  git push -u origin "${BRANCH_NAME}"

  # Create a PR
  # https://cli.github.com/manual/gh_pr
  gh pr create \
    --title "${PR_TITLE}" \
    --body "${PR_BODY}" \
    --base "${default_branch}"

  # Return to parent directory
  cd ..

  echo
done

echo "All done!"

I would really appreciate a good review of this code, given that we dont want to accidentally create like a 1000 PRs or something like that. (Also not sure if there is a good place to put that in a repo so Im just pasting it here)

[John15321]

Yes, Another place, I've planning to add is https://github.com/flatcar/.github/blob/main/profile/README.md -- this way our github profile page would also have information.

Thats a good idea! That one can be done by hand

[John15321]

Also as Chewi pointed out in a different PR, we do have 2 separate slack channels. This creates a problem, if we want to add a badge that leads our users to our slack channels, which one do we put there? Or do we put both, one saying its CNCF and the other Kubernetes server? I would really appreciate some input on that from you guys 😄

[John15321]

The badges are already present in the scripts repo so you can take a look at how they would look like:
https://github.com/flatcar/scripts

[chewi]

The script looks good to me.

[sayanchowdhury]

Also as Chewi pointed out in a different PR, we do have 2 separate slack channels. This creates a problem, if we want to add a badge that leads our users to our slack channels, which one do we put there? Or do we put both, one saying its CNCF and the other Kubernetes server? I would really appreciate some input on that from you guys 😄

Yes, CNCF slack is the recently created one, and as the Kubernetes one is the older one it gets more visibility. We could just mention the Kubernetes one, and the CNCF one remains unlisted?

[John15321]

Also as Chewi pointed out in a different PR, we do have 2 separate slack channels. This creates a problem, if we want to add a badge that leads our users to our slack channels, which one do we put there? Or do we put both, one saying its CNCF and the other Kubernetes server? I would really appreciate some input on that from you guys 😄

Yes, CNCF slack is the recently created one, and as the Kubernetes one is the older one it gets more visibility. We could just mention the Kubernetes one, and the CNCF one remains unlisted?

Lets do that for now

[John15321]

A slightly edited version, I had to fork each to make sure I have push rights.

#!/usr/bin/env bash
set -euo pipefail

# Your GitHub username
GITHUB_USER="John15321"

# Replace these with the repositories you actually want to modify
REPOS=(
  # "update-ssh-keys"
  # "cluster-api-bootstrap-provider-kubeadm-ignition"
  # "flatcar-terraform"
  # "init"
  # "Flatcar"
  # "seismograph"
  # "locksmith"
  # "azure-vhd-utils"
  # "lerobot"
  # "flatcar-app-jitsi"
  # "shim-review"
  # "update_engine"
  # ".github"
  # "container-linux-config-transpiler"
  # "baselayout"
  # "flatcar-dev-util"
  # "flatcar-build-scripts"
  # "mayday"
  # "toolbox"
  "torcx"
  "azure-marketplace-ingestion-api"
  "flatcar-release-mirror"
  "sdnotify-proxy"
  "nss-altfiles"
  "flatcar-automation"
  "flatcar-packer-qemu"
  "sysroot-wrappers"
  "flatcar-mastodon"
  "updateservicectl"
  "flatcar-ipxe-scripts"
  "nebraska-update-agent"
  "fleetlock"
  "flog"
  "ign-converter"
  "flatcar-cloud-image-uploader"
  "flatcar-linux-update-operator"
  "ignition"
  "go-omaha"
)

# Lines for the badge snippet
BADGE_LINES=(
  "<div style=\"text-align: center\">"
  ""
  "[![Flatcar OS](https://img.shields.io/badge/Flatcar-Website-blue?logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAyNi4wLjMsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4wIiBpZD0ia2F0bWFuXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4Ig0KCSB2aWV3Qm94PSIwIDAgODAwIDYwMCIgc3R5bGU9ImVuYWJsZS1iYWNrZ3JvdW5kOm5ldyAwIDAgODAwIDYwMDsiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4NCgkuc3Qwe2ZpbGw6IzA5QkFDODt9DQo8L3N0eWxlPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQ0MCwxODIuOGgtMTUuOXYxNS45SDQ0MFYxODIuOHoiLz4NCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MDAuNSwzMTcuOWgtMzEuOXYxNS45aDMxLjlWMzE3Ljl6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNTQzLjgsMzE3LjlINTEydjE1LjloMzEuOVYzMTcuOXoiLz4NCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik02NTUuMiw0MjAuOXYtOTUuNGgtMTUuOXY5NS40aC0xNS45VjI2MmgtMzEuOVYxMzQuOEgyMDkuNFYyNjJoLTMxLjl2MTU5aC0xNS45di05NS40aC0xNnY5NS40aC0xNS45djMxLjINCgloMzEuOXYxNS44aDQ3Ljh2LTE1LjhoMTUuOXYxNS44SDI3M3YtMTUuOGgyNTQuOHYxNS44aDQ3Ljh2LTE1LjhoMTUuOXYxNS44aDQ3Ljh2LTE1LjhoMzEuOXYtMzEuMkg2NTUuMnogTTQ4Ny44LDE1MWg3OS42djMxLjgNCgloLTIzLjZ2NjMuNkg1MTJ2LTYzLjZoLTI0LjJMNDg3LjgsMTUxTDQ4Ny44LDE1MXogTTIzMywyMTQuNlYxNTFoNjMuN3YyMy41aC0zMS45djE1LjhoMzEuOXYyNC4yaC0zMS45djMxLjhIMjMzVjIxNC42eiBNMzA1LDMxNy45DQoJdjE1LjhoLTQ3Ljh2MzEuOEgzMDV2NDcuN2gtOTUuNVYyODYuMUgzMDVMMzA1LDMxNy45eiBNMzEyLjYsMjQ2LjRWMTUxaDMxLjl2NjMuNmgzMS45djMxLjhMMzEyLjYsMjQ2LjRMMzEyLjYsMjQ2LjRMMzEyLjYsMjQ2LjR6DQoJIE00NDguMywzMTcuOXY5NS40aC00Ny44di00Ny43aC0zMS45djQ3LjdoLTQ3LjhWMzAyaDE1Ljl2LTE1LjhoOTUuNVYzMDJoMTUuOUw0NDguMywzMTcuOXogTTQ0MCwyNDYuNHYtMzEuOGgtMTUuOXYzMS44aC0zMS45DQoJdi03OS41aDE1Ljl2LTE1LjhoNDcuOHYxNS44aDE1Ljl2NzkuNUg0NDB6IE01OTEuNiwzMTcuOXY0Ny43aC0xNS45djE1LjhoMTUuOXYzMS44aC00Ny44di0zMS43SDUyOHYtMTUuOGgtMTUuOXY0Ny43aC00Ny44VjI4Ni4xDQoJaDEyNy4zVjMxNy45eiIvPg0KPC9zdmc+DQo=)](https://www.flatcar.org/)"
  "[![Matrix](https://img.shields.io/badge/Matrix-Chat%20with%20us!-green?logo=matrix)](https://app.element.io/#/room/#flatcar:matrix.org)"
  "[![Slack](https://img.shields.io/badge/Slack-Chat%20with%20us!-4A154B?logo=slack)](https://kubernetes.slack.com/archives/C03GQ8B5XNJ)"
  "[![Twitter Follow](https://img.shields.io/twitter/follow/flatcar?style=social)](https://x.com/flatcar)"
  "[![Mastodon Follow](https://img.shields.io/badge/Mastodon-Follow-6364FF?logo=mastodon)](https://hachyderm.io/@flatcar)"
  "[![Bluesky](https://img.shields.io/badge/Bluesky-Follow-0285FF?logo=bluesky)](https://bsky.app/profile/flatcar.org)"
  ""
  "</div>"
  ""
)

BRANCH_NAME="add-badges-flatcar"
COMMIT_MESSAGE="Add badges to README"
PR_TITLE="Add badges to README"
PR_BODY="This PR prepends a set of Flatcar-related badges to the README."

for repo in "${REPOS[@]}"; do
  echo "==================================================================="
  echo "Processing repository: flatcar/${repo}"
  echo "==================================================================="

  # Step 1: Fork the repo to your personal account
  echo "Forking flatcar/${repo} to ${GITHUB_USER}/${repo}..."
  gh repo fork "flatcar/${repo}" --clone=false

  # Step 2: Clone your forked repo
  echo "Cloning your fork..."
  gh repo clone "${GITHUB_USER}/${repo}" -- -q
  cd "${repo}"

  # Step 3: Set up upstream remote to track the original repo
  echo "Setting up upstream remote..."
  # Check if the upstream remote already exists
  if ! git remote | grep -q "^upstream$"; then
    git remote add upstream "https://github.com/flatcar/${repo}.git"
  else
    echo "Upstream remote already exists, skipping..."
  fi
  
  # Always fetch from upstream to get latest changes
  git fetch upstream

  # Step 4: Get the default branch of the upstream repo
  echo "Determining default branch from upstream..."
  default_branch=$(gh repo view "flatcar/${repo}" --json defaultBranchRef -q '.defaultBranchRef.name')
  echo "Default branch is: ${default_branch}"

  # Step 5: Create a new branch based on the latest upstream default branch
  echo "Creating branch based on upstream/${default_branch}..."
  git checkout -b "${BRANCH_NAME}" "upstream/${default_branch}"

  # Step 6: Prepend lines to README.md
  echo "Modifying README.md..."
  if [ -f README.md ]; then
    cp README.md README.md.bak
    {
      # Print each badge line
      for line in "${BADGE_LINES[@]}"; do
        echo "$line"
      done
      # Then append old content
      cat README.md.bak
    } > README.md
    rm README.md.bak
  else
    # If no README yet, just create one with badges
    for line in "${BADGE_LINES[@]}"; do
      echo "$line"
    done > README.md
  fi

  # Step 7: Commit & push to your fork
  echo "Committing changes..."
  git add README.md
  git commit -m "${COMMIT_MESSAGE}"
  echo "Pushing to your fork..."
  git push -u origin "${BRANCH_NAME}"

  # Step 8: Create a PR from your fork to the original repo
  echo "Creating PR to upstream..."
  pr_url="https://github.com/${GITHUB_USER}/${repo}/pull/new/${BRANCH_NAME}?expand=1"
  
  if gh pr create \
    --title "${PR_TITLE}" \
    --body "${PR_BODY}" \
    --repo "flatcar/${repo}" \
    --base "${default_branch}" \
    --head "${GITHUB_USER}:${BRANCH_NAME}"; then
    
    echo "PR created for flatcar/${repo}"
  else
    echo "Error creating PR via CLI. Please create it manually by visiting:"
    echo "${pr_url}"
    
    if command -v xdg-open &> /dev/null; then
      xdg-open "${pr_url}"
    elif command -v open &> /dev/null; then
      open "${pr_url}"
    fi
  fi

  # Return to parent directory
  cd ..

  echo
done

echo "All done!"