1.1.1 • Published 2 years ago

github-repository-distributor v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

github-repository-distributor

This action provides the following functionality for GitHub Actions users:

  • get all your repos and group by lang.
  • order your repos by last update time
  • can be use by npm

Usage

Github Action

See action.yml and Demo

Basic:

steps:
- uses: actions/checkout@v2
- name: Use Node.js
  uses: actions/setup-node@v2
  with:
    node-version: 16
- name: Generate markdown files
  uses: sonofmagic/github-repository-distributor@main
  with:
    token: ${{ secrets.PERSONAL_TOKEN }} # your github personal token
    username: 'sonofmagic' # your github name
- name: Commit & Push changes
  uses: actions-js/push@master
  with:
    github_token: ${{ secrets.PERSONAL_TOKEN }} # your github personal token

Nodejs

npm i github-repository-distributor
# or
yarn add github-repository-distributor
const { main } = require('github-repository-distributor')

main({
  token: process.env.GITHUB_TOKEN,
  username: 'sonofmagic',
  filepath: 'test/fixtures/README.md',
  motto: false,
  title: 'Hello world!',
  includeFork: 'true'
})

Options

NameTypeDescriptionDefault Value
tokenstringthe repo PAT or GITHUB_TOKEN
usernamestringgithub username to generate markdown files
filepathstringmain markdown file pathREADME.md
mottostring | booleanwhether add powered by footer'false'
titlestringmain markdown h1 titlerepo.name
includeForkstring | booleaninclude forked repos'false'
includeArchivedstring | booleaninclude archived repos'false'
onlyPrivatestring | booleanonly include private repos'false'
1.1.1

2 years ago

1.1.0

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.0.3

2 years ago

0.0.2

2 years ago