Code Monkey home page Code Monkey logo

github-funding-yml-updater's Introduction

github-funding-yml-updater Build Status

Update multiple repositories's .github/FUNDING.yml at once via GitHub API.

It will help you to setup GitHub Sponsors for your repository.

Features

  • Setup .github/FUNDING.yml for GitHub Sponsors
  • No need to clone git repository in local
    • This tools using GitHub API

Install

Install with npm:

npm install github-funding-yml-updater -g
# or
npx -p github-funding-yml-updater github-funding-yml-updater [opions]

Usage

Usage
  $ github-funding-yml-updater [options]

Options
  --mode "add", "delete", or "overwrite"
    --mode "add" and --mode "delete" require --user argument
    --mode "overwrite" require --funding-file argument
  --user GitHub account name
  --list-file input list file path. list file includes line-separated repository list for updating
  --funding-file input FUNDING.yml file path. It is for --mode overwrite
  --write update GitHub repository if set it. Default: dry-run(no update)
  --token GitHub Token(or env GITHUB_TOKEN=xxx)

Examples
  # Dry-run by default
  $ github-funding-yml-updater --mode add --user azu --list-file list.txt --token XXXX
  # Add user to Repository
  $ github-funding-yml-updater --mode add --user azu --list-file list.txt --token XXXX --write
  # Delete user from Repository
  $ github-funding-yml-updater --mode delete --user azu --list-file list.txt --token XXXX --write
  # Overwrite using existing FUNDING.yml
  $ github-funding-yml-updater --mode overwrite --funding-file ./FUNDING.yml --list-file list.txt --token XXXX --write

You should get GitHub Token(has repo permission) from next url.

--write

github-funding-yml-updater dry-run by default.

If you want to update actual repository, you should run it --write options.

--mode

  • add: add --user to repositories
  • delete: delete --user from repositories
  • overwrite: overwrite by --funding-file

--list-file

--list-file specify text file that is following format:

owner/repo
owner/repo@branch
https://github.com/owner/repo

Example of list.txt:

azu/example1@develop
azu/example2
example/example

๐Ÿ“ Tips

curl + jq can generate your repositories.

export GH_USER="azu"
curl -s "https://api.github.com/search/repositories?q=user:${GH_USER}&&per_page=100" | jq ".items[].full_name" > list.txt

Examples

Add gh-user to each repositories:

github-funding-yml-updater --mode add --user gh-user --list-file list.txt --token $GITHUB_TOKEN --write

Remove gh-user from each repositories:

github-funding-yml-updater --mode delete --user gh-user --list-file list.txt --token $GITHUB_TOKEN --write

Overwrite .github/FUNDING.yml with a file.yml:

github-funding-yml-updater --mode overwrite --funding-file file.yml --list-file list.txt --token $GITHUB_TOKEN --write

Notice โš ๏ธ

Currently, only put .github/FUNDING.yml and does not show sponsor button.

You should turn on Sponsorships on your GitHub repository's settings:

Sponsorship check

This tools includes helper tool that show settings url from list file.

npm install github-funding-yml-updater -g
github-funding-yml-settings --list-file list.txt

Or

npx -p github-funding-yml-updater github-funding-yml-settings --list-file list.txt

This tools output setting links from list.txt.

https://github.com/azu/example1/settings#repository-funding-links-feature
https://github.com/azu/example2/settings#repository-funding-links-feature

References

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT ยฉ azu

github-funding-yml-updater's People

Contributors

azu avatar mono0926 avatar munierujp avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

github-funding-yml-updater's Issues

shouldUpdate flag seems to be not used in delete mode

in add mode:

                const shouldUpdate = !hasUserInFunding(fundingContent, user);
                if (!options.silent) {
                    console.info(`${repoMark}: ${shouldUpdate ? "Try to Update" : "No Update"}`);
                }
                if (!options.dryRun && shouldUpdate) {
                    // ...
                }

in delete mode:

                const shouldUpdate = hasUserInFunding(fundingContent, user);
                console.log("shouldUpdate", fundingContent);
                if (!options.silent) {
                    console.info(`${repoMark}: ${shouldUpdate ? "Try to Delete" : "No Update"}`);
                }
                if (!options.dryRun) {
                    // ...
                }

It would be correct code is... ๐Ÿค”

if (!options.dryRun && shouldUpdate) {
  // ...
}

feature request: Use local file for overwriting FUNDING.yml files on remote branches

I'd like to add external funding platforms to my FUNDING.yml files.

Idea of usage

Create FUNDING.yml to local.

github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]

Run command.

$ github-funding-yml-updater --mode overwrite --user octocat --list-file list.txt --funding-file FUNDING.yml --token ${GITHUB_TOKEN} --write

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.