https://github.com/bobdotcom/oprf-asset-updater

A workflow which automatically updates OPRF standard asset files from the OpRedFlag repository
https://github.com/bobdotcom/oprf-asset-updater

Last synced: 30 days ago
JSON representation

A workflow which automatically updates OPRF standard asset files from the OpRedFlag repository

• Host: GitHub
• URL: https://github.com/bobdotcom/oprf-asset-updater
• Owner: BobDotCom
• License: gpl-3.0
• Created: 2023-09-21T01:44:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-14T22:05:58.000Z (3 months ago)
• Last Synced: 2024-10-16T00:38:05.548Z (3 months ago)
• Size: 91.8 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OPRF Asset Updater

A workflow which automatically updates OPRF standard asset files from the OpRedFlag repository

## Usage

### Step 1

First, update all of your OPRF asset files.

This is important because otherwise, the initial run of the script could cause issues.

### Step 2

Create a file in your repository root called `oprf-versions.json`. The contents of the file should look something like this:

```json

{

  "missile-code": {

    "version": null,

    "path": "Nasal/missile-code.nas"

  },

  "damage": [

    {

      "version": null,

      "path": "Aircraft1/Nasal/damage.json"

    },

    {

      "version": null,

      "path": "Aircraft2/Nasal/damage.json"

    }

  ]

}

```

The keys of the JSON (in this case, "missile-code" and "damage") correspond to the ID of an OPRF asset. You can view all available options [here](https://github.com/NikolaiVChr/OpRedFlag/blob/master/versions.json).

For each of those keys, you should have a version number and a file path. The file path should be set to the location of the asset file, relative to your repository's root. For now, you can leave the "version" set to null.

If you have multiple copies of a file in your repository (i.e., if you have multiple aircraft in the same repo),

you can include them as a list. 

### Step 3

Create a workflow file in your repository.

You can use the template below.

If you have little experience with workflows, don't worry—this file will work fine as-is.

```yaml

name: OPRF Asset Updater

on:

  # Once Daily

  schedule: 

    - cron: "0 0 * * *"

  # When the workflow is manually run

  workflow_dispatch:

    inputs:

      include:

        description: "Files to update, separated by commas"

        required: false

        default: "*"

      exclude:

        description: "Files to skip, separated by commas"

        required: false

        default: ""

      compatibility:

        description: "Compatibility level, will only allow updates of this level or lower"

        required: true

        default: "minor"

        type: choice

        options:

          - "major"

          - "minor"

          - "patch"

          - "none"

jobs:

  update:

    # Needs to be a UNIX system

    runs-on: ubuntu-latest

    # Needs permission to write files to update them

    permissions:

      contents: write

    steps:

      - name: "Manual Update"

        uses: BobDotCom/[email protected]

        if: "${{ github.event_name == 'workflow_dispatch' }}"

        with:

          include: ${{ inputs.include }}

          exclude: ${{ inputs.exclude }}

          compatibility: ${{ inputs.compatibility }}

      - name: "Scheduled Update"

        uses: BobDotCom/[email protected]

        if: "${{ github.event_name != 'workflow_dispatch' }}"

```

### Step 4

Create a manual workflow run, and wait until it finishes.



Once it's done, check the commit history for your repository, and make sure no incompatible changes were added in the last commit. If needed, update your aircraft to make it compatible.

### Step 5

Now your repo is set up! Once per day, your repository will check for changes from the oprf repository, and if there are any compatible changes, it will update your assets.

Occasionally, incompatible changes will be made.

You should check from time to time, making sure you aren't out of date.

If an incompatible change is made, you will need to make sure your aircraft is ready for the changes,

then create a manual workflow run (See [Step 4](#step-4)), and select the "major" option. 

## Advanced Usage

The following is an extended example with all available options.

```yaml

- uses: BobDotCom/[email protected]

  with:

    # Optional. Local branch to checkout and apply changes to

    # Default: Default branch ("")

    branch: "main"

    # Optional. Location of OpRedFlag asset GitHub repository, in User/Repo format

    # Default: "NikolaiVChr/OpRedFlag"

    repository: 'BobDotCom/OpRedFlag'

    # Optional. The branch of the OpRedFlag repository to use

    # Default: "master"

    repository-branch: 'feature-123'

    # Optional. Location of local versions.json file

    # Default: "oprf-versions.json"

    version-file: 'data/versions.json'

    # Optional. Asset keys to update, separated by commas.

    # Default: All ("*")

    include: 'damage,missile-code,datalink'

    # Optional. Asset keys to skip, separated by commas.

    # Default: None ("")

    exclude: 'station-manager,iff'

    # Optional. Only allow updates of this level or lower

    # Choices: "major", "minor", "patch", "none"

    # Default: "minor"

    compatibility: 'minor'

    # Optional. Fail if local file versions are newer than remote

    # Default: "false"

    strict: 'false'

    # Optional. The title of the commit that is made

    # Default: "Auto-Update Shared Files"

    commit_message: "Auto-Update OPRF Files"

```