/Github-Auto-Follow-Unfollow-View-User-List

👔 A feature that unfollows all non-followers of the owner and a feature that follows back those who were not being followed by the owner. GitHub Action automatically creates or updates Readme with users(followers) list and current user information.

Primary LanguageJavaScriptMIT LicenseMIT

Auto Follows & Unfollows by GitHub Actions for GitHub users

A feature that unfollows all non-followers of the owner and a feature that follows back those who were not being followed by the owner. GitHub Action automatically creates or updates README with information of owner and followers.

Usage

The purpose of this program is to generate an updated README file for any user's repository, displaying details about their account's followers and current user's info. The program also implements two functions to perform actions on the GitHub API: a feature that unfollows all non-followers of the owner and a feature that follows back those who were not being followed by the owner.

Example

name: Github-Auto-Follow-Unfollow-View-User-List

on:
  workflow_dispatch:
  schedule:
    - cron: '0 */8 * * 1-5'

jobs:
  auto-update:
    runs-on: ubuntu-latest
    steps:
      - name: Github-Auto-Follow-Unfollow-View-User-List
        uses: Huniko519/Github-Auto-Follow-Unfollow-View-User-List@main
        with:
          token: ${{ secrets.TOKEN }}
          repository: ${{ github.repository }}
          isReadmeUpdate: true
          safeUserList: 'Liu-Yong-HK,Huniko-Team'

Example Link

Inputs

inputs required default description
token true ${{ github.token }} The token used to authenticate.
repository true ${{ github.repository }} The name of the repository.
isReadmeUpdate false ${{ github.isReadmeUpdate }} Readme update enable status.
safeUserList false ${{ github.safeUserList }} Lists of Safe Users.

Input of this action

  • input:
    • token: GitHub personal access token with at least 'read:user' and 'repo' scope. ⚠️ You should store this token as secret. This input is required.
    • repository: This is the name of installed repository. This input is required.

Contributors

Huniko519
Huniko519
Liu Yong
Liu Yong

LICENSE

Copyright (c) 2023-present Huniko519