Skip to content
trash

GitHub Action

Node.js Cleanup

v1.1.3 Latest version

Node.js Cleanup

trash

Node.js Cleanup

A GitHub Action that cleanup Node.js template configures

Installation

Copy and paste the following snippet into your .yml file.

              
- name: Node.js Cleanup

              
  uses: ryohidaka/[email protected]
Learn more about this action in ryohidaka/nodejs-cleanup

Choose a version

Node.js Cleanup

release Test Action License

ko-fi

A GitHub Action that cleanup Node.js template configures.

Usage

on:
  push:
    branches:
      - main

jobs:
  template-cleanup:
    name: Template Cleanup
    runs-on: ubuntu-latest
    if: github.event.repository.name != 'nodejs-cleanup'
    permissions:
      contents: write
    steps:
      # Check out current repository
      - name: Fetch Sources
        uses: actions/checkout@v4

      # Cleanup project
      - name: Cleanup
        uses: ryohidaka/[email protected]
        with:
          description: "new description"
          version: "1.0.0"
          remove-license: true
          excluded: "test-dir, test.txt"

Inputs

Input Required Default Description
description The description of the project.
version 0.0.0 The version of the project.
email The email address to be used in the project.
bugs-url The URL where the project's bugs are tracked.
homepage The URL of the project's homepage.
remove-license false A boolean value that indicates whether to remove the license.
excluded Comma-separated list of file or directory paths to remove.
template-dir The path to the project's template directory.
remove-template-dir false A boolean value indicating whether to remove the template directory.
placeholders {"name": "%NAME%", "description": "%DESCRIPTION%", "author": "%AUTHOR%"} A JSON string to specify the placeholders for the project
commit-user-name GitHub Actions The username for the commit.
commit-user-email [email protected] The user email for the commit.
commit-message Template cleanup The commit message.
dryrun false Execute the process, but do not push the commit at the end.

License

This project is licensed under the MIT License - see the LICENSE file for details.