Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/.github/workflows
History
Joey Parrish 31ad9a2539
ci: Fix repo settings for self-hosted runners and debugging (#1110) 
The hack of using "secrets" to store per-repo settings was not working.
The main reason is that pull_request workflows don't have access to
secrets no matter what you do. So it was impossible to make this work
for settings like "ENABLE_SELF_HOSTED" for PR tests.

This change replaces that old hack with a new one. Now a repo owner must
create a "GitHub Environment" with the name of the setting they want to
enable. Currently supported values are "self_hosted", to add self-hosted
runners to the build/test matrix, and "debug", to start an SSH server
for debugging when a workflow fails.

Issue #1047 (CMake porting)
 		2022-10-25 08:53:45 -07:00
..
README.md ci: Fix repo settings for self-hosted runners and debugging (#1110) 2022-10-25 08:53:45 -07:00
build-docs.yaml ci: Fix repo settings for self-hosted runners and debugging (#1110) 2022-10-25 08:53:45 -07:00
build-matrix.json ci: Fix repo settings for self-hosted runners and debugging (#1110) 2022-10-25 08:53:45 -07:00
build.yaml ci: Fix repo settings for self-hosted runners and debugging (#1110) 2022-10-25 08:53:45 -07:00
docker-hub-release.yaml chore: Mass-update copyright headers (#1086) 2022-08-26 08:44:59 -07:00
docker-image.yaml chore: Mass-update copyright headers (#1086) 2022-08-26 08:44:59 -07:00
github-release.yaml chore: Mass-update copyright headers (#1086) 2022-08-26 08:44:59 -07:00
lint.yaml chore: Mass-update copyright headers (#1086) 2022-08-26 08:44:59 -07:00
npm-release.yaml chore: Mass-update copyright headers (#1086) 2022-08-26 08:44:59 -07:00
pr.yaml ci: Fix repo settings for self-hosted runners and debugging (#1110) 2022-10-25 08:53:45 -07:00
settings.yaml ci: Fix repo settings for self-hosted runners and debugging (#1110) 2022-10-25 08:53:45 -07:00
sync-labels.yaml chore: Sync common workflows (#1039) 2022-02-28 21:14:32 -08:00
test-linux-distros.yaml ci: Fix repo settings for self-hosted runners and debugging (#1110) 2022-10-25 08:53:45 -07:00
update-docs.yaml chore: Mass-update copyright headers (#1086) 2022-08-26 08:44:59 -07:00
update-issues.yaml chore: Sync common workflows (#1039) 2022-02-28 21:14:32 -08:00
validate-pr-title.yaml chore: Sync common workflows (#1037) 2022-02-25 10:12:44 -08:00

README.md

GitHub Actions CI

Reusable workflows

  • build.yaml: Build and test all combinations of OS & build settings. Also builds docs on Linux.

  • build-docs.yaml: Build Packager docs. Runs only on Linux.

  • docker-image.yaml: Build the official Docker image.

  • lint.yaml: Lint Shaka Packager.

  • test-linux-distros.yaml: Test the build on all Linux distros via docker.

Composed workflows

  • On PR (pr.yaml), invoke:

    • lint.yaml
    • build.yaml
    • build-docs.yaml
    • docker-image.yaml
    • test-linux-distros.yaml

  • On release tag (github-release.yaml):

    • Create a draft release
    • Invoke:
      • lint.yaml
      • build.yaml
      • test-linux-distros.yaml
    • Publish the release with binaries from build.yaml attached

  • On release published:

    • docker-hub-release.yaml, publishes the official Docker image
    • npm-release.yaml, publishes the official NPM package
    • update-docs.yaml:
      • Invoke build-docs.yaml
      • Push the output to the gh-pages branch

Common workflows from shaka-project

  • sync-labels.yaml
  • update-issues.yaml
  • validate-pr-title.yaml

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

Repo Settings

Each of these workflow features can be enabled by creating a "GitHub Environment" with the same name in your repo settings. Forks will not have these enabled by default.

  • debug: enable debugging via SSH after a failure
  • self_hosted: enable self-hosted runners in the build matrix