https://github.com/cfpb/open-source-checklist
check internal repos against open source checklist requirements
https://github.com/cfpb/open-source-checklist
Last synced: 17 days ago
JSON representation
check internal repos against open source checklist requirements
- Host: GitHub
- URL: https://github.com/cfpb/open-source-checklist
- Owner: cfpb
- License: cc0-1.0
- Archived: true
- Created: 2016-06-10T23:18:38.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-18T22:44:03.000Z (over 7 years ago)
- Last Synced: 2024-04-08T00:16:58.511Z (about 2 years ago)
- Language: JavaScript
- Homepage:
- Size: 211 KB
- Stars: 484
- Watchers: 19
- Forks: 37
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-projects - open-source-checklist - check internal repos against open source checklist requirements ⭐651 `JavaScript` (📦 Legacy & Inactive Projects)
README
# Open Source Checklist
Automating CFPB's [Open Source Checklist](https://github.com/cfpb/open-source-project-template/blob/master/opensource-checklist.md) for easy release of internal source code.
## Dependencies
- [Node.js](https://nodejs.org/en/)
## Installation
To use [scrub.sh](scrub.sh) to scrub GHE urls:
### Add environment variable
1. Add `.env` and `scrub.sh` to your project's `.gitignore` list.
1. Copy [`.env_SAMPLE`](.env_SAMPLE) to your project's root.
1. Rename `.env_SAMPLE` to `.env`.
1. Edit `fake.ghe.url` to point to the real GHE url (do not include `https://`).
1. `cd` into your project repo root to activate the new environment variable. You should receive a warning and then a confirmation message:
## Usage
1. In Terminal, from project root, run:
```bash
./scrub.sh
```
1. Force push your repo with tags:
```bash
git push -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.
### Rebase steps
Only use if you must keep a branch that you're working with locally:
```
git checkout feature-branch
git rebase master
```
## Troubleshooting
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](#add-environment-variable).
## How to test the software
If the software includes automated tests, detail how to run those tests.
## Known issues
Document any known significant shortcomings with the software.
## Getting help
If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
## Getting involved
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!](CONTRIBUTING.md)
----
## Open source licensing info
1. [TERMS](TERMS.md)
2. [LICENSE](LICENSE)
3. [CFPB Source Code Policy](https://github.com/cfpb/source-code-policy/)
----
## Credits and references
1. Projects that inspired you
2. Related projects
3. Books, papers, talks, or other sources that have meaningful impact or influence on this project