Skip to content

Commit

Permalink
Add build workflow (#4)
Browse files Browse the repository at this point in the history
* Add build workflow

* Attempt to authenticate with github package registry for installing packages

* update required node.js version and set github envvar so electron-build can draft a release

* Update readme and package.json version

* Change version to 0.23.1 and workflow branch to main
  • Loading branch information
kristianhentschelbbc authored Jan 28, 2025
1 parent 21715ca commit b5dcf65
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 10 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: App build

on:
push:
branches:
- main
jobs:
build_and_release:
runs-on: macos-14

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: "22.x"
- name: authenticate with github package registry
run: npm set "//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}"
- run: npm ci
- run: npm run dist
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ci
name: docs publish
on:
push:
branches:
Expand Down
10 changes: 3 additions & 7 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,10 @@ All dependencies and scripts are listed in the single `package.json` at the top

## Releases and versions

The [Changelog](./Changelog.md) and [GitHub Releases](https://github.com/bbc/audio-orchestrator/releases) are updated manually, usually on minor version increments (e.g. `0.17.0` to `0.18.0`). We create a Github release linked to a git tag for that version.
A [GitHub action](.github/workflows/build.yml) automatically attaches built installers to a draft release when a PR is merged into the main branch, and a draft release with the tag name `v${version}` matching the package.json version exists.

To create a release build run the `npm run dist` task. Attach these files to the release on GitHub:

- `dist/Audio Orchestrator-<version>.dmg`
- `dist/Audio Orchestrator-<version>-arm64.dmg`
- `dist/Audio Orchestrator Setup <version>.exe`
NB apps built this way are not signed or notarized by Apple/Microsoft and may require additional authorization to run. This is the same as with the MakerBox installers distributed previously.

## History

_Audio Orchestrator_ was originally developed in the [BBC R&D](https://www.bbc.co.uk/rd/) Audio Team by Kristian Hentschel with contributions from Jon Francombe, Emma Young, Danial Haddadi, and Sonal Tandon between 2019 and 2022. It was distributed through the BBC _Connected Studio MakerBox_, and to several public pilots on [BBC Taster](https://www.bbc.co.uk/taster/). The software is now available to interested members of the community through this Audio Orchestrator open source repository, but will not see significant further development from the BBC.
_Audio Orchestrator_ was originally developed in the [BBC R&D](https://www.bbc.co.uk/rd/) Audio Team by Kristian Hentschel with contributions from Jon Francombe, Emma Young, Danial Haddadi, and Sonal Tandon between 2019 and 2022. It was distributed through the BBC _Connected Studio MakerBox_ site, and used in several public pilots on [BBC Taster](https://www.bbc.co.uk/taster/). The software is now available to interested members of the community through this Audio Orchestrator open source repository, but will not see significant further development from the BBC.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"license": "GPL-3.0-or-later",
"private": true,
"engines": {
"node": ">=20.0.0"
"node": ">=22.0.0"
},
"scripts": {
"build:react-frontend": "(cd react-frontend && webpack --mode production)",
Expand Down

0 comments on commit b5dcf65

Please sign in to comment.