mirror of https://github.com/shaka-project/shaka-packager.git synced 2026-04-03 03:40:05 +00:00

Files

Joey Parrish 89d59a3601 ci: Update comments for the settings workflow (#1476 )

Since the introduction of `vars` to GitHub Actions, I started using that
instead of the "environments" trick I used in Packager. However, it has
become clear now that the `vars` strategy has major drawbacks, such as
requiring the use of `pull_request_target`, which should only be used
for actions that do not execute PR-author-controlled code.

This updates the comments to clarify why this is used. This reusable
settings workflow will also be deployed now in other repos to
standardize on this "environments" mechanism, which is safer than
`vars`.

2025-01-17 14:18:54 -08:00

build-docker.yaml

ci: Do not persist credentials after checkout (#1464 )

2024-12-18 08:25:39 -08:00

build-docs.yaml

ci: Do not persist credentials after checkout (#1464 )

2024-12-18 08:25:39 -08:00

build.yaml

ci: Do not persist credentials after checkout (#1464 )

2024-12-18 08:25:39 -08:00

lint.yaml

ci: Upgrade pylint to support Python 3.12 (#1472 )

2025-01-10 08:11:04 -08:00

pr.yaml

ci: Fix workflow events (#1446 )

2024-11-05 14:34:47 -08:00

publish-docker.yaml

ci: Do not persist credentials after checkout (#1464 )

2024-12-18 08:25:39 -08:00

publish-docs.yaml

ci: Update actions (#1360 )

2024-03-05 09:28:51 -08:00

publish-npm.yaml

ci: Update nodejs to a maintained version (#1466 )

2024-12-19 17:53:50 -08:00

README.md

feat!: Rewrite build system and third-party dependencies (#1310 )

2023-12-01 09:32:19 -08:00

release-please.yaml

fix(ci): Fix incomplete 3.4.1 release (#1471 )

2025-01-16 15:44:10 -08:00

settings.yaml

ci: Update comments for the settings workflow (#1476 )

2025-01-17 14:18:54 -08:00

sync-labels.yaml

chore: Sync common workflows (#1465 )

2024-12-18 08:35:37 -08:00

test-linux-distros.yaml

ci: Do not persist credentials after checkout (#1464 )

2024-12-18 08:25:39 -08:00

update-issues.yaml

chore: Sync common workflows (#1465 )

2024-12-18 08:35:37 -08:00

validate-pr-title.yaml

chore: Sync common workflows (#1262 )

2023-09-01 19:26:57 -07: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.
build-docker.yaml: Build the official Docker image.
lint.yaml: Lint Shaka Packager.
publish-docs.yaml: Publish Packager docs. Runs on the latest release.
publish-docker.yaml: Publish the official docker image. Runs on all releases.
publish-npm.yaml: Publish binaries to NPM. Runs on all releases.
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
- build-docker.yaml
- test-linux-distros.yaml

Release workflow

release-please.yaml
- Updates changelogs, version numbers based on conventional commits syntax and semantic versioning
  - https://conventionalcommits.org/
  - https://semver.org/
- Generates/updates a PR on each push
- When the PR is merged, runs additional steps:
  - Creates a GitHub release
  - Invokes publish-docs.yaml to publish the docs
  - Invokes publish-docker.yaml to publish the docker image
  - Invokes build.yaml
  - Attaches the binaries from build.yaml to the GitHub release
  - Invokes publish-npm.yaml to publish the binaries to NPM

Common workflows from shaka-project

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

Required Repo Secrets

RELEASE_PLEASE_TOKEN: A PAT for shaka-bot to run the release-please action. If missing, the release workflow will use the default GITHUB_TOKEN
DOCKERHUB_CI_USERNAME: The username of the Docker Hub CI account
DOCKERHUB_CI_TOKEN: An access token for Docker Hub
- To generate, visit https://hub.docker.com/settings/security
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
- To generate, visit https://www.npmjs.com/settings/shaka-bot/tokens and select the "Automation" type
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