Automating CFPB's Open Source Checklist for easy release of internal source code.
To use scrub.sh to scrub GHE urls:
- Add
.envandscrub.shto your project's.gitignorelist. - Copy
.env_SAMPLEto your project's root. - Rename
.env_SAMPLEto.env. - Edit
fake.ghe.urlto point to the real GHE url (do not includehttps://). cdinto your project repo root to activate the new environment variable. You should receive a warning and then a confirmation message:
- In Terminal, from project root, run:
./scrub.sh
- Force push your repo with tags:
git push <remote> <branch> -f --tags- Remember to tell your collaborators to clone a fresh copy!
Note: If collaborators have branches that they’d like to maintain separately, they will need to fetch and rebase from your updated remote. This must be done via rebase, not merge.
If a collaborator is just mirroring the upstream repo with their fork, they can simply delete their local copy and clone a new one.
Only use if you must keep a branch that you're working with locally:
git checkout feature-branch
git rebase master
If you get the following error when running scrub.sh:
sed: first RE may not be empty
msg filter failed
You did not activate the environment variable for the GHE url. Make sure you update the GHE_URL variable and activate it.
If the software includes automated tests, detail how to run those tests.
Document any known significant shortcomings with the software.
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
This software currently has no tests which means it's certainly broken. Want to write bash scripts, node.js modules, break some git histories and probably some other things? Contributions welcome!
- Projects that inspired you
- Related projects
- Books, papers, talks, or other sources that have meaningful impact or influence on this project