https://github.com/pierredemailly/node-ga-updater

Update your GitHub Actions.
https://github.com/pierredemailly/node-ga-updater

Last synced: over 1 year ago
JSON representation

Update your GitHub Actions.

• Host: GitHub
• URL: https://github.com/pierredemailly/node-ga-updater
• Owner: PierreDemailly
• License: mit
• Created: 2023-06-25T17:34:13.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-10T16:19:53.000Z (over 2 years ago)
• Last Synced: 2025-02-28T06:19:40.884Z (over 1 year ago)
• Language: JavaScript
• Size: 27.3 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# node-ga-updater

![version](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&url=https://raw.githubusercontent.com/PierreDemailly/node-ga-updater/main/package.json&query=$.version&label=Version)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)](https://github.com/PierreDemailly/node-ga-updater/graphs/commit-activity)

[![mit](https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge)](https://github.com/PierreDemailly/node-ga-updater/blob/main/LICENSE)

Update your GitHub Actions.

> [!IMPORTANT]

>  This tool uses pinned version only for security purpose.

## Requirements

- [Node.js](https://nodejs.org/en/) v18 or higher

## Getting Started

```bash

npx node-ga-updater

```

## Usage

Use `--update-all` or `-u` (alias) to skip prompts and update all by default.

```bash

npx node-ga-updater -u

```

Use `--path` or `-p` (alias) for custom path. Default `.github/workflows`.

Use `--silent` or `-s` (alias) to skip stdout logs.

Use `--commit` or `-c` (alias) to commit after initialisation. Default `false`.

Use `--message` or `-m` (alias) to provide custom commit message when `--commit` is thruthy. Default `chore: update GitHub Actions`

> [!TIP]

> You can stack short flags (when no flag argument), for instance `-scm "foo"` is equivalent to `-s -c -m "foo"`.

## Authentication

You can authenticate yourself to the GitHub API if you wont be annoyed with **Rate Limits**.

Create a `.env` if you don't have one.

```bash

touch .env

```

Add this following ENV variable

```bash

# GitHub access token

GITHUB_TOKEN=your_token

```

You can create a GitHub token [here](https://github.com/settings/tokens)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
PierreD
💻 📖

      
Kouadio Fabrice Nguessan
💻 📖

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!