Skip to content

Commit

Permalink
Merge branch 'master' into build
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Mar 21, 2021
2 parents c11bc25 + 584cf3d commit 16b5fe2
Show file tree
Hide file tree
Showing 3 changed files with 508 additions and 437 deletions.
22 changes: 19 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,13 @@ jobs:
- name: Copy ./nodecg-temp > ./nodecg
run: cp -r ./nodecg-temp ./nodecg

# Checkout this repository
# Checkout the main branch of this repository with full depth
- name: Checkout this repository
uses: actions/checkout@v2
with:
token: ${{ secrets['GH_PAT'] }}
ref: master
fetch-depth: 0
path: ./nodecg/bundles/esa-featuredchannels

# Set the local git user config to use the GitHub Actions bot account
Expand All @@ -37,6 +40,14 @@ jobs:
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
# Recheckout both the main and build branches and merge the main into build.
- name: (Re)checkout both branches and merge main into build
working-directory: ./nodecg/bundles/esa-featuredchannels
run: |
git checkout master
git checkout build
git merge master
# Setup some Node stuff
- name: Node.js setup
uses: actions/setup-node@v2
Expand Down Expand Up @@ -70,20 +81,25 @@ jobs:
# Actually build everything
- name: Build
working-directory: ./nodecg/bundles/esa-featuredchannels
run: npm run build
run: |
npm run clean
npm run build
# Commit newly built files
# This can "fail" if there are no newly changed/built files, but the next step should continue anyway.
- name: Commit built files
id: commit
continue-on-error: true
working-directory: ./nodecg/bundles/esa-featuredchannels
run: |
git add -f extension
git commit -m "Built files" -a
# Pushes the built files to a specific branch
- name: Push built files to "build" branch
#if: ${{ steps.commit.outcome == 'success' }}
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets['GH_PAT'] }}
branch: build
force: true
directory: ./nodecg/bundles/esa-featuredchannels
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@

## Installation

This is a [NodeCG](https://nodecg.com) v1.6.0 bundle. You will need to have NodeCG v1.6.0 or above installed to run it. It also requires you to install the [nodecg-speedcontrol](https://github.com/speedcontrol/nodecg-speedcontrol) bundle (at least v2.1.0).
This is a [NodeCG](https://nodecg.com) v1.8.1 bundle. You will need to have NodeCG v1.8.1 or above installed to run it. It also requires you to install the [nodecg-speedcontrol](https://github.com/speedcontrol/nodecg-speedcontrol) bundle (at least v2.2.0).

Install this bundle just like any other NodeCG bundle; if you have `nodecg-cli` you can:
- Use `nodecg install esamarathon/esa-featuredchannels`, then...
- Do `nodecg defaultconfig featuredchannels` to generate a default configuration file.

If not obvious, you must be logged into/authorised with Twitch in the `nodecg-speedcontrol` bundle to be able to change featured channels.

You must also set the `channelName` setting in your `nodecg-speedcontrol` Twitch configuration to "esamarathon" if not done already, `ffzIntegration` to `true` (if not done already) and `ffzUseRepeater` to `true`. See [the relevant README](https://github.com/speedcontrol/nodecg-speedcontrol/blob/dev/READMES/Configuration.md#twitch) for more information.
You must also set the `channelName` setting in your `nodecg-speedcontrol` Twitch configuration to "esamarathon" (if not done already), `ffzIntegration` to `true` (if not done already) and `ffzUseRepeater` to `true`. See [the relevant README](https://github.com/speedcontrol/nodecg-speedcontrol/blob/master/READMES/Configuration.md#twitch) for more information.

## Configuration

Expand All @@ -28,8 +28,8 @@ You must also set the `channelName` setting in your `nodecg-speedcontrol` Twitch
}
```

- `address`: Address to the external server that will be used, only change this if requested.
- `postKey`: Key used to authenticate your changes, will be supplied to you.
- `address`: Address to the external server that will be used; only change this if requested.
- `postKey`: Key used to authenticate your changes; will be supplied to you.


## Usage
Expand Down
Loading

0 comments on commit 16b5fe2

Please sign in to comment.