github-content-sync

GITHUB CONTENT SYNC 🔎 📁

The Github Content Sync tool is a command-line script written in Go that allows you to compare the contents of two folders within a GitHub repository.
It helps identify files that are present in one folder but not in another, as well as files that have newer commits in one folder compared to another.

Purpose

The purpose of this tool is to facilitate the comparison of folder contents within a GitHub repository.
This was specifically meant for those repo that contain documentation in various languages (divided into different folders) and you need a fast way to know the deltas:
In this case, usually the reference folder and "source of truth" is the "english" one (for an example take a look at this repo).
Generally, it can be useful in scenarios where you have two folders within a repository and you want to identify the differences between them, such as missing files or files with newer commits.

Arguments

The script requires the following environment variables to be set:

• REPO_URL: The URL of the GitHub repository to analyze.
• REPO_FOLDER_1: The name of the first folder to compare.
• REPO_FOLDER_2: The name of the second folder to compare.
• GITHUB_TOKEN: An access token with appropriate permissions to access the repository.

How it works

The script performs the following steps:

1. Checks the presence of the required environment variables and their values.
2. Creates a GitHub client using the provided access token.
3. Retrieve the content of the two specified folders via the Github client object.
4. Compares the contents of the two specified folders within the repository.
5. Retrieves files that exist in both folders and have newer commits in the first folder.
6. Prints the files that are present in the first folder but not in the second folder.
7. Prints the files with newer commits in the first folder compared to the same files in the second folder.

Examples

Here are some examples of how to use the Folder Comparison Tool:

1. Compare two folders within a GitHub repository:

export REPO_URL=https://github.com/cncf/glossary
export REPO_FOLDER_1=content/en
export REPO_FOLDER_2=content/it
export GITHUB_TOKEN=your-github-token

./github-content-sync

Output:

   __   __ _____   _ __  _ __   ___      __   _    _  __ _____   ___   _  __ _____      ___  _  __   _  __   __
 ,'_/  / //_  _/  /// / /// /  / o.)   ,'_/ ,' \  / |/ //_  _/  / _/  / |/ //_  _/    ,' _/ | |/,'  / |/ / ,'_/
/ /_n / /  / /   / ` / / U /  / o \   / /_ / o | / || /  / /   / _/  / || /  / /     _\ `.  | ,'   / || / / /_
|__,'/_/  /_/   /_n_/  \_,'  /___,'   |__/ |_,' /_/|_/  /_/   /___/ /_/|_/  /_/     /___,' /_/    /_/|_/  |__/

[ ALL ENVIRONMENT VARIABLES ARE CONFIGURED ]

[ FILES PRESENT IN content/en BUT NOT IN content/it ]
_TEMPLATE.md
application-programming-interface.md
auto-scaling.md
bare-metal-machine.md
blue-green-deployment.md
chaos-engineering.md
cloud-computing.md
cloud-native-apps.md
cloud-native-security.md
container-image.md
container-orchestration.md
container.md
continuous-delivery.md
continuous-deployment.md
continuous-integration.md
contributor-ladder
data-center.md
database-as-a-service.md
digital-certificate.md
distributed-systems.md
edge-computing.md
event-streaming.md
function-as-a-service.md
gitops.md
horizontal-scaling.md
hypervisor.md
kubernetes.md
load-balancer.md
microservices-architecture.md
mutual-transport-layer-security.md
pod.md
policy-as-code.md
role-based-access-control.md
serverless.md
service-discovery.md
service-proxy.md
stateless-apps.md
transport-layer-security.md
vertical-scaling.md
virtualization.md
zero-trust-architecture.md


[ FILES PRESENT IN BOTH content/en AND content/it WITH NEWER COMMITS IN content/en ]
_index.md
abstraction.md
agile-software-development.md
canary-deployment.md
client-server-architecture.md
cluster.md
containers-as-a-service.md
contribute
debugging.md
devsecops.md
distributed-apps.md
event-driven-architecture.md
firewall.md
idempotence.md
infrastructure-as-code.md
loosely-coupled-architecture.md
managed-services.md
monolithic-apps.md
multitenancy.md
nodes.md
observability.md
platform-as-a-service.md
portability.md
reliability.md
scalability.md
self-healing.md
service.md
site-reliability-engineering.md
software-as-a-service.md
style-guide
tightly-coupled-architectures.md
version-control.md
virtual-machine.md


 ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___
/__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__//__/

With Docker (Local Build)

This repo also contain a Dockerfile so you can launch the script as a docker container.
buil the image:

docker build -t github-content-sync:latest .

Run the docker container (change env vars accordingly):

docker run -it --rm -e REPO_URL=https://github.com/cncf/glossary -e REPO_FOLDER_1=content/en -e REPO_FOLDER_2=content/it -e GITHUB_TOKEN=<your-token-here> github-content-sync:latest

With Docker (Github Packages)

Alternatively, this repo already contains an action to publish the script's OCI image to Github Packages.
Pull the version that you want:

docker pull ghcr.io/r3drun3/github-content-sync:1.1.7 

Run the docker container (change env vars accordingly):

docker run -it --rm -e REPO_URL=https://github.com/cncf/glossary -e REPO_FOLDER_1=content/en -e REPO_FOLDER_2=content/it -e GITHUB_TOKEN=<your-token-here> ghcr.io/r3drun3/github-content-sync:1.1.7

Run via Github Action

This script is also executed inside a Github action, you can configure this via the goaction.yaml manifest.

License

This script is released under the MIT License.
Feel free to modify and distribute it as per your needs.