https://github.com/hunghg255/action-modify-file

Action Modify File
https://github.com/hunghg255/action-modify-file

actions

Last synced: about 1 month ago
JSON representation

Action Modify File

• Host: GitHub
• URL: https://github.com/hunghg255/action-modify-file
• Owner: hunghg255
• Created: 2024-08-29T04:27:05.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T05:17:28.000Z (3 months ago)
• Last Synced: 2024-09-29T23:23:03.980Z (about 2 months ago)
• Topics: actions
• Language: TypeScript
• Homepage:
• Size: 196 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        










  A Github actions to modify files in a repository.





  

  



## Usage

## Inputs

### `path`

**Required** The path to the file to write.

### `contents`

**Required** The contents of the file.

### `mode`

**Optional** The mode of writing to use: `overwrite`, `append`, or `preserve`.

Modes:

- `overwrite` - overwrite the file if it exists

- `append` - if the file exists, it will be appended to

- `preserve` - if the file already exists the contents will not be written to

**Default** `append`

## Outputs

### `size`

Returns the file size.

## Example usage

```yaml

uses: hunghg255/action-modify-file@main

with:

  path: ${{ env.home}}/.bashrc

  contents: |

    Hello World!

  mode: append

```

## Example usage with checkout, commit and push

```yaml

name: Overwrite some file

on:

  push:

    branches: [main]

  workflow_dispatch:

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout repo

        uses: actions/checkout@v3

      - name: Overwrite file

        uses: 'hunghg255/action-modify-file@main'

        with:

          path: path/to/file.js

          mode: overwrite

          contents: |

            console.log('some contents')

      - name: Commit & Push

        uses: Andro999b/[email protected]

        with:

          github_token: ${{ secrets.GITHUB_TOKEN }}

          branch: main

          force: true

          message: 'Overwritten by Github Actions - ${date}'

```