{"id":15581473,"url":"https://github.com/moralcode/logchange","last_synced_at":"2025-04-07T03:36:26.707Z","repository":{"id":113204055,"uuid":"309889067","full_name":"MoralCode/logchange","owner":"MoralCode","description":"a simple interactive bash script to assist with recording information about major changes made to your system for easier reinstalls and searching of repeat issues and their solutions.","archived":false,"fork":false,"pushed_at":"2020-11-04T04:46:50.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-13T08:21:48.773Z","etag":null,"topics":["scripts-bash"],"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/MoralCode.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":"2020-11-04T04:43:30.000Z","updated_at":"2020-11-04T04:51:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"ba9bcf0b-db7c-4729-98a4-10bcb31c5bf9","html_url":"https://github.com/MoralCode/logchange","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoralCode%2Flogchange","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoralCode%2Flogchange/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoralCode%2Flogchange/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoralCode%2Flogchange/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MoralCode","download_url":"https://codeload.github.com/MoralCode/logchange/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247589828,"owners_count":20963022,"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":["scripts-bash"],"created_at":"2024-10-02T19:48:36.003Z","updated_at":"2025-04-07T03:36:26.662Z","avatar_url":"https://github.com/MoralCode.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# logchange\na simple interactive bash script to assist with recording information about major changes made to your system for easier reinstalls and searching of repeat issues and their solutions.\n\n## Usage\n### Logging a change\nTo use this script to log a new change, type `logchange` into your terminal to activate the script.\n\nOnce activated, the script will interactively ask you a series of simple questions:\n\n| Question      | Expected Input | Purpose |\n| ----------- | ----------- | ----------- |\n| Is this a [s]ystem change or a [U]ser change? | `s`, `u` or `enter` to accept the default of `U` (case insensitive) | This records whether this change is user-level (i.e. home-folder configs) or system level (i.1. /etc/ configs, sudo apt install, etc.) |\n| What piece of software does this change affect? (i.e. Firefox) | Free Response, defaults to the empty string | Provides a place to record whether this affects a particular piece of software |\n| What/Where/Why? | Free Response, defaults to the empty string | provides a place to explain the problem being solved and include potential keywords for later searching |\n| Is there a link to go with this change? | Free Response, defaults to the empty string | Provides a place to include a link to stackoverflow or any site to record where you found the solution to the problem in case its needed later |\n\n### Log file format\nYour answers to the above questions will be appended to the changelog file in one of the following formats:\n\n\nSystem: `[D System] M \u003cL\u003e`\n\nUser: `[D User] { A }: M \u003cL\u003e`\n\nwhere the capital letters serve as placeholders for:\n- D - the datetime at which this entry was made\n- A - the name of the affected application as entered\n- M - the message explaining the issue as entered\n- L - the link provided (if any)\n\n### Help Text\n```\nlogchange.sh [[-h|--help]|[--oops|--undo]|[ --show|--list]|--open] -- a simple interactive bash script to assist with recording information about major changes made to your system.\n\nwhere:\n    -h|--help  show this help text\n    --oops|--undo  removes the last line added to the changelog after a confirmation prompt\n    --show|--list  output the contents of the changelog file using the cat utility\n    --open  open the changelog file in the kate text editor\n```\n\n\n## Setup\n\nTo set up this script, place the `logchange.sh` script somewhere on your system where the path is not likely to change. Then, in your favorite startup location of choice (maybe `.profile` is a safe default? not sure which one is best for what), paste the following lines and edit as appropriate (none have trailing slashes):\n\n```\nexport CHANGELOG_DIR=\"path/to/where/you/want/the/changelog/file\"\nalias logchange=/path/to/logchange.sh\nalias changelog='logchange --show'\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoralcode%2Flogchange","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoralcode%2Flogchange","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoralcode%2Flogchange/lists"}