https://github.com/olivr/inject-file-action

GitHub action to inject the content of a remote file into a file of your repo.
https://github.com/olivr/inject-file-action

actions github open-source

Last synced: 16 days ago
JSON representation

GitHub action to inject the content of a remote file into a file of your repo.

• Host: GitHub
• URL: https://github.com/olivr/inject-file-action
• Owner: Olivr
• License: apache-2.0
• Created: 2020-05-11T13:32:52.000Z (almost 5 years ago)
• Default Branch: v1
• Last Pushed: 2023-01-06T05:39:28.000Z (about 2 years ago)
• Last Synced: 2025-02-01T16:48:58.357Z (17 days ago)
• Topics: actions, github, open-source
• Language: JavaScript
• Homepage:
• Size: 1.11 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Inject file action

[![tests](https://github.com/olivr-com/inject-file-action/workflows/tests/badge.svg)](https://github.com/olivr-com/inject-file-action/actions?query=workflow%3Atests)

GitHub action to inject the content of a remote file into a file of your repo.

We use this action to maintain an organization-wide central repo with common sections of a README.md (about our company, license, contributing, etc.). Other repos sync with the latest versions of those sections every time they're built.

## Usage

### Simple example

It will look for **two occurences** of `` in the file `README.md` and inject the content of `https://test.com/about.md` between these two occurences. If this action can't find these occurences, it will inject the content at the end of the `README.md` file.

```yaml

uses: olivr-com/inject-file-action@v1

with:

  url: https://test.com/about.md

  target: README.md

```

> `` is used because the file being pulled is called _**about**.md_

### Complete example

It will look for **two occurences** of `` in the file `README.md` and inject the content of `https://test.com/about.md` between these two occurences. If this action can't find them, it will **not** inject anything.

```yaml

uses: olivr-com/inject-file-action@v1

with:

  url: https://test.com/about.md

  target: README.md

  pattern: 

  force: false

```

## Contribute

Checkout the v1 branch

Install the dependencies

```bash

npm install

```

Run the tests

```bash

npm test

```

### Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

Run package

```bash

npm run package

```

Since the packaged index.js is run from the dist folder.

```bash

git add dist

```