Skip to content

fellipe30k/one-commit-every-day

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Welcome to the One Commit Every Day Project! 🕒

Welcome, programmer! This project is designed to generate daily commits with custom messages using AI. It’s all automated, but you’re free to modify everything to suit your needs. Let’s explore the world of fun, automation, and creativity! 🌟

🌐 Multilingual Instructions

🇧🇷 Como executar o projeto:

  1. Certifique-se de ter o Docker e o Docker Compose instalados.
  2. Configure sua chave SSH:
    • Aviso: Você precisa ter uma conta no GitHub configurada com sua chave SSH. Sem isso, nada vai funcionar! 😱
    • Copie sua chave pública e privada usando o comando do Makefile: make build.
  3. Para iniciar o projeto, execute:
    make up
  4. Para executar os testes:
    make test
  5. Desligue tudo:
    make down
  6. Nota Importante: Sempre que você alterar os valores nos parâmetros do main.go, lembre-se de executar make build novamente. Sem isso, suas alterações não serão aplicadas! 🔧

🇺🇸 How to run the project:

  1. Ensure Docker and Docker Compose are installed.
  2. Set up your SSH key:
    • Warning: You must have a GitHub account configured with your SSH key. Without it, nothing will work! 😱
    • Use the Makefile command to copy your public and private keys: make build.
  3. Start the project with:
    make up
  4. Run tests:
    make test
  5. Shut down:
    make down
  6. Important Note: Whenever you change values in the main.go parameters, remember to run make build again. Without this, your changes won’t take effect! 🔧

🇲🇽 Cómo ejecutar el proyecto:

  1. Asegúrate de tener Docker y Docker Compose instalados.
  2. Configura tu clave SSH:
    • Advertencia: Debes tener una cuenta de GitHub configurada con tu clave SSH. ¡Sin esto, nada funcionará! 😱
    • Usa el comando del Makefile para copiar tus claves pública y privada: make build.
  3. Inicia el proyecto con:
    make up
  4. Ejecuta las pruebas:
    make test
  5. Apaga todo:
    make down
  6. Nota Importante: Siempre que cambies los valores en los parámetros de main.go, recuerda ejecutar make build nuevamente. ¡Sin esto, tus cambios no se aplicarán! 🔧

🛠️ Things You Can Edit 📝

Configurations in main.go

All configurations for this project are located in the const block:

const (
    ollamaURL      = "http://ollama:11434/api/generate" // URL for the Ollama API
    outputDir      = "generated_files"                // Directory for saving generated files
    promptOllama   = "I'm going to write a simple readme.md that explains how to write a simple hello world in Python:" // The AI prompt
    cronSchedule  = "0 10 * * 1-5" // At 10:00 AM, Monday to Friday // Cron schedule for generating commits
    fileExtension  = "md"                             // File extension for generated files
)

What You Can Change:

  1. ollamaURL: Update the URL if your Ollama API is hosted elsewhere.
  2. outputDir: Change the directory where generated files are saved.
  3. promptOllama: Modify the prompt to generate messages tailored to your needs.
  4. cronSchedule: Adjust the cron schedule to generate commits at different times.
  5. fileExtension: Change the file type for the generated files (e.g., txt, json).

Important Reminder: Whenever you make changes to these values, you must rebuild the project using make build. Otherwise, your changes won’t apply, and you’ll be stuck wondering why things aren’t working. 🤔

Documentation

AI Model

This project uses the llama3.2:1b model from Ollama. It’s lightweight, fast, and efficient for generating meaningful messages. Feel free to experiment with other models available in the Ollama suite.


🌟 Additional Features

  • Fork-Friendly: Clone, fork, and modify this project as you like.
  • Customizable Cron Jobs: Edit the cronSchedule to generate commits as frequently as desired.
  • Extensible Code: The code is clean and modular, so you can easily add new features or modify existing ones.

💡 Notes for Developers

  • Always ensure your SSH keys are correctly set up.
  • Test modifications locally using make test before deploying changes.
  • Keep the fun alive by exploring new prompts and tweaking automation settings.

🎉 Have fun and automate your GitHub commits like a pro! 🚀

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors