{"id":18412560,"url":"https://github.com/topagrume/auto_changelog","last_synced_at":"2025-06-13T19:32:12.576Z","repository":{"id":250952785,"uuid":"802249561","full_name":"TopAgrume/auto_changelog","owner":"TopAgrume","description":"Automatic changelogs compatible to git","archived":false,"fork":false,"pushed_at":"2024-07-30T21:58:25.000Z","size":147,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T00:17:46.446Z","etag":null,"topics":["changelog","commit","github-config","logging","tagging"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TopAgrume.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-17T20:27:26.000Z","updated_at":"2024-07-30T21:58:27.000Z","dependencies_parsed_at":"2024-07-31T01:57:45.512Z","dependency_job_id":"5edabb4a-02d2-4c40-8147-4253c11fb14a","html_url":"https://github.com/TopAgrume/auto_changelog","commit_stats":null,"previous_names":["topagrume/auto_changelog"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TopAgrume/auto_changelog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TopAgrume%2Fauto_changelog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TopAgrume%2Fauto_changelog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TopAgrume%2Fauto_changelog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TopAgrume%2Fauto_changelog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TopAgrume","download_url":"https://codeload.github.com/TopAgrume/auto_changelog/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TopAgrume%2Fauto_changelog/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259707327,"owners_count":22899405,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["changelog","commit","github-config","logging","tagging"],"created_at":"2024-11-06T03:42:38.294Z","updated_at":"2025-06-13T19:32:12.531Z","avatar_url":"https://github.com/TopAgrume.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Auto_Changelog Management Scripts\n\nThis repository contains two bash scripts designed to help manage changelogs in a Git repository: `create_log_commit.sh` and `create_log_tag.sh`. These scripts work together to create a streamlined process for maintaining changelogs across different branches and merging them when creating new tags.\n\n## Scripts Overview\n\n### 1. create_log_commit.sh\n\nThis script is used to create log entries for individual commits. It's designed to be run before each commit or as a pre-commit hook.\n\nKey features:\n- Creates branch-specific metalog files in the `.logs` directory\n- Supports conventional commit message format\n- Allows for detailed descriptions of changes\n- Can be run in interactive mode inside VSCode\n\n### 2. create_log_tag.sh\n\nThis script is used to compile all metalog entries into a final changelog when creating a new tag. It's designed to be run when merging into the main branch or as a post-merge hook.\n\nKey features:\n- Processes all `.metalogs` files in the `.logs` directory\n- Compiles entries into a single changelog file (default: `changelog.md`)\n- Cleans up processed metalog files after updating the changelog\n\n## Installation\n\n1. Clone this repository or download the scripts.\n2. Make the scripts executable:\n```sh\nchmod +x create_log_commit.sh create_log_tag.sh\n```\n3. Place the scripts in your project's root directory / in a location within your PATH or create an alias linked to these scripts.\n\n## Usage\n\n### create_log_commit.sh\n\nRun this script before making a commit:\n\n```sh\n./create_log_commit.sh [OPTIONS] \u003ctype\u003e [\u003cdestination_file\u003e]\n```\n\nOptions:\n- `--help`: Display help message\n- `-v`: Enable verbose mode\n\nArguments:\n- `type`: The type of change (e.g., 'feat', 'fix', 'update', etc.)\n- `destination_file`: (Optional) The changelog file to update (default: changelog.md)\n\n\u003cbr\u003e\n\nA new window opens on a temporary file and presents the content of a `git status`.\nNow, you just need to:\n- Write the commit message between the `\"\"\"` `\"\"\"`.\n- Write the description of changes for the logs of each modified file.\n    - Each comment starting with a `#` is ignored by the logs.\n    - Each line starting with a `#` (or deleted) is ignored by the logs and by git.\n- Save the file (it will automatically delete)\n\n\u003cbr\u003e\n\n**Example:**\n\n![commit_prompt](images/commit_prompt.png)\n\n**Given instructions inside stdout:**\n\n![commit_instructions](images/commit_instructions.png)\n### create_log_tag.sh\n\nRun this script when you want to create a new tag and update the main changelog:\n```sh\n./create_log_tag.sh [OPTIONS] \u003ctag\u003e [\u003cdestination_file\u003e]\n```\nOptions:\n- `--help`: Display help message\n- `-v`: Enable verbose mode\n\nArguments:\n- `tag`: The new tag version (e.g., '1.2.3')\n- `destination_file`: (Optional) The changelog file to update (default: changelog.md)\n\n## Best Practices\n\n1. Run `create_log_commit.sh` to replace git commit to ensure all changes are logged.\n2. Use descriptive commit messages following the conventional commit format.\n3. Run `create_log_tag.sh` when creating a new release or merging into the main branch.\n4. Regularly review and clean up the `.logs` directory if needed.\n\n## Incoming Updates\n\n- Interactive Mode\n- Integration with CI/CD\n- Git Hook Integration\n- Customizable Categories / Changelog Formatting Options\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftopagrume%2Fauto_changelog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftopagrume%2Fauto_changelog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftopagrume%2Fauto_changelog/lists"}