{"id":18328930,"url":"https://github.com/dollarshaveclub/harmless-changes","last_synced_at":"2025-04-06T01:32:27.511Z","repository":{"id":57261414,"uuid":"120385504","full_name":"dollarshaveclub/harmless-changes","owner":"dollarshaveclub","description":"Ignore unnecessary build steps if changes are harmless to make builds faster 🏎 💨","archived":false,"fork":false,"pushed_at":"2020-01-02T23:38:12.000Z","size":64,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-21T15:11:04.137Z","etag":null,"topics":["ci","circleci","continuous-delivery","continuous-integration","test-automation","testing-tools","travis-ci"],"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/dollarshaveclub.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}},"created_at":"2018-02-06T01:36:53.000Z","updated_at":"2022-07-01T11:26:45.000Z","dependencies_parsed_at":"2022-08-25T05:10:31.268Z","dependency_job_id":null,"html_url":"https://github.com/dollarshaveclub/harmless-changes","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/dollarshaveclub%2Fharmless-changes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dollarshaveclub%2Fharmless-changes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dollarshaveclub%2Fharmless-changes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dollarshaveclub%2Fharmless-changes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dollarshaveclub","download_url":"https://codeload.github.com/dollarshaveclub/harmless-changes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247423476,"owners_count":20936621,"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":["ci","circleci","continuous-delivery","continuous-integration","test-automation","testing-tools","travis-ci"],"created_at":"2024-11-05T19:15:42.174Z","updated_at":"2025-04-06T01:32:26.093Z","avatar_url":"https://github.com/dollarshaveclub.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Harmless Changes\n\nHarmless changes is a simple bash script that helps ignore unneeded build steps if code changes are harmless. This utility can speed up CI build times! 🏎 💨\n\n⚠️  **NOTE:** This code is currently untested. Tests are in progress! \n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#summary\"\u003eSummary\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#install\"\u003eInstall\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#use\"\u003eUse\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#thanks\"\u003eThanks\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n## Summary\n\nCI build steps can test many things, but what if the Pull Request to a `master` branch contains only for changes to a repository's README or a slight change to an image? Harmless Changes checks if the **only** changes that were made within a Pull Request were for items that can be ignored in CI via a `.ciingore` file. CI build steps can be exited if the Harmless Changes script finds that only files within the `.ciignore` file were ignored.\n\n----\n\n## Install\n\nClone:\n```\ngit clone git@github.com:dollarshaveclub/harmless-changes.git\n```\nNPM \n```\nnpm i harmless-changes --save-dev\n```\n\n----\n\n## Use\n\nThe documentation below provides steps to using harmless changes\n\n### Make a `.ciignore`\n\nThe `.ciignore` file is used to ingore certain files during the ci (build) process\n\nIn a terminal:\n```bash\ntouch .ciignore\n```\n\n### Check if changes are harmless\n\nWith CI build steps in **[CircleCI]()** or **[Travis]()**, configure CI to work according to whether harmless exits with a 1 or 0.\n\nAdd a script to run harmless changes, in example:\n\n```bash\nif npx harmless-changes; then\n  exit 0\n fi\n\n# or \n# if an older version of NPM is being used\nif ./node_modules/.bin/harmless-changes; then\n exit 0\nfi\n\n# or, finally\n# if Harmless Changes has not been installed with NPM (the code below is an assumed path)\nif ./harmless-changes.sh; then\n  exit 0\nfi\n```\n\nCI will/can now exit if only harmless changes were made.\n\n----\n\n## Contributing\n\nPlease contribute to Harmless Changes by filing an [issue](/issues),responding to issues, or reaching out socially—etc.\n\nHarmless Changes is a utility. It may not be beneficial to many repositories if builds are simple. However, as test grow, and project builds become more complex, Harmless Changes is a simple tool that can save lots of time!\n\n----\n\n## Thanks\n\nThis utility was thought up and made for [Dollar Shave Club](https://www.dollarshaveclub.com/home) by [Brian Gonzalez](https://github.com/briangonzalez/) and [Jon Ong](https://github.com/jonathanong) while the team was implementing continuous integration. Along with [CircleCi](https://circleci.com/), [ES Check](https://www.npmjs.com/package/es-check), [gh-automerge](https://github.com/jonathanong/gh-automerge), [Greenkeeper](https://greenkeeper.io/), [Jest](https://facebook.github.io/jest/) and [Mocha](https://mochajs.org/), Harmless Changes is a utility that Dollar Shave Club has used to save the company many engineer hours per week with fast builds. \n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdollarshaveclub%2Fharmless-changes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdollarshaveclub%2Fharmless-changes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdollarshaveclub%2Fharmless-changes/lists"}