Skip to content

Added basic exclusions for repositories to the main function and to the example json config file. #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
henri wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Added basic exclusions for repositories to the main function and to the example json config file. #11

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d34c7d
added basic support for excluding repositories
henri Mar 1, 2024
87c1d0b
removed some debug information
henri Mar 1, 2024
c1d55be
updated example config file to include exclude-repo option
henri Mar 1, 2024
8ca5f16
Updates README.md
henri Mar 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Updates README.md
  • Loading branch information
@henri
henri authored Mar 3, 2024
commit 8ca5f16fed5b936985ed7b0e329111d1a6eed19b
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,20 @@ As an example let's create a file, `config.json`. This file should contain the t
}
```

#### Choose some repositories to exclude from the backup.

By default, all repositories you have read access to are backed up. To exclude some repos, add `exclude-repos` to `config.json`:

```
{
"token": "6b86190dd45c57c1a1b039a5a54d892e019102f7",
"directory": "~/backups/github.com",
"exclude-repo": ["dont-need-this-repo", "forked-repo-to-skip", "the-giant-repo-to-skip"]
}
```
Keep in mind that if a repo has already been backed up it will not be deleted. But it will no longer continue to be updated with subsequient backups. You could manually delete the excldued repository and it would not come back when you run the backup script again, as the repository was excluded.


#### Choose users and organizations to back up

By default, all repositories you have read access to are backed up. To choose which users' and organizations' repos are backed up, add `owners` to `config.json`:
Expand Down