shaka-packager/.github/workflows
Joey Parrish bbd0a1afa6 build: Make release binary names more consistent
Now that we have multiple architectures, we should factor both OS and
architecture into the names of release binaries.  This makes the names
more formulaic, as well as consistent with the static-ffmpeg-binaries
repository.  Shaka Streamer will pull binaries from both this repo and
that one, so consistent names would be helpful.

The pssh-box release is actually OS and architecture independent, so
remove the suffix from that and only release one copy of it.

Change-Id: Ief3de49fae267c5267647a8dd4377023777ead37
2021-08-26 20:44:40 +00:00
..
custom-actions build: Make release binary names more consistent 2021-08-26 20:44:40 +00:00
README.md ci: Use GITHUB_TOKEN instead of SHAKA_BOT_TOKEN (#977) 2021-08-12 10:50:29 -07:00
build_and_test.yaml build: Make release binary names more consistent 2021-08-26 20:44:40 +00:00
docker_hub_release.yaml Make CI workflows safe when testing in a fork 2021-06-17 13:36:59 -07:00
github_release.yaml build: Make release binary names more consistent 2021-08-26 20:44:40 +00:00
npm_release.yaml Make CI workflows safe when testing in a fork 2021-06-17 13:36:59 -07:00
update_docs.yaml ci: Use GITHUB_TOKEN instead of SHAKA_BOT_TOKEN (#977) 2021-08-12 10:50:29 -07:00

README.md

GitHub Actions CI

Actions

  • custom-actions/lint-packager: Lints Shaka Packager. You must pass fetch-depth: 2 to actions/checkout in order to provide enough history for the linter to tell which files have changed.
  • custom-actions/build-packager: Builds Shaka Packager. Leaves build artifacts in the "artifacts" folder. Requires OS-dependent and build-dependent inputs.
  • custom-actions/test-packager: Tests Shaka Packager. Requires OS-dependent and build-dependent inputs.
  • custom-actions/build-docs: Builds Shaka Packager docs.

Workflows

  • On PR:
    • build_and_test.yaml: Builds and tests all combinations of OS & build settings. Also builds docs.
  • On release tag:
    • github_release.yaml: Creates a draft release on GitHub, builds and tests all combinations of OS & build settings, builds docs on all OSes, attaches static release binaries to the draft release, then fully publishes the release.
  • On release published:
    • docker_hub_release.yaml: Builds a Docker image to match the published GitHub release, then pushes it to Docker Hub.
    • npm_release.yaml: Builds an NPM package to match the published GitHub release, then pushes it to NPM.
    • update_docs.yaml: Builds updated docs and pushes them to the gh-pages branch.

Required Repo Secrets

  • DOCKERHUB_CI_USERNAME: The username of the Docker Hub CI account
  • DOCKERHUB_CI_TOKEN: An access token for Docker Hub
  • DOCKERHUB_PACKAGE_NAME: Not a true "secret", but stored here to avoid someone pushing bogus packages to Docker Hub during CI testing from a fork
    • In a fork, set to a private name which differs from the production one
  • NPM_CI_TOKEN: An "Automation"-type access token for NPM for the shaka-bot account
  • NPM_PACKAGE_NAME: Not a true "secret", but stored here to avoid someone pushing bogus packages to NPM during CI testing from a fork
    • In a fork, set to a private name which differs from the production one