Repository files navigation

Automating CFPB'sOpen Source Checklist for easy release of internal source code.

• Node.js

To usescrub.sh to scrub GHE urls:

1. Add.env andscrub.sh to your project's.gitignore list.
2. Copy.env_SAMPLE to your project's root.
3. Rename.env_SAMPLE to.env.
4. Editfake.ghe.url to point to the real GHE url (do not includehttps://).
5. cd into your project repo root to activate the new environment variable. You should receive a warning and then a confirmation message:

1. In Terminal, from project root, run:

./scrub.sh

1. Force push your repo with tags:

git push<remote><branch> -f --tags

1. 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-branchgit rebase master

If you get the following error when runningscrub.sh:

sed: first RE may not be empty

msg filter failed

You did not activate the environment variable for the GHE url. Make sure youupdate 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!

1. TERMS
2. LICENSE
3. CFPB Source Code Policy

1. Projects that inspired you
2. Related projects
3. Books, papers, talks, or other sources that have meaningful impact or influence on this project