Skip to content

bcgov/actions

Repository files navigation

bcgov/actions (Shared GitHub Actions)

A centralized repository for custom GitHub Actions used across the bcgov organization.


🧪 Testing & PR Guidelines

To maintain "Boss Level" consistency across all our actions, every PR should:

  1. Pass Linting: All .sh files must pass shellcheck.
  2. Include Functional Tests: Add or update a workflow in .github/workflows/ that exercises the action (use dry_run: true where appropriate).
  3. Verify Outputs: Don't just check if it "ran"—verify that the outputs are actually what you expect.

🏗 Sub-Actions

Find CODEOWNERS and coordinate notifications (GitHub Issues) on job failures.

  • Icon: alert-circle (red)
  • Uses: bcgov/actions/workflow-notifier@v1

🛠 Scaffolding a New Action

Use the included scaffolding script to create a new action following our standards.

```bash

From the root of this repo:

chmod +x scaffold.sh ./scaffold.sh "Optional description" ```

This will:

  1. Create a new directory.
  2. Seed it with the standard `action.yml`.
  3. Provide a base `action.sh` script.
  4. Generate a starter `README.md`.

✨ Standards & Principles

  1. Standard Inputs: All actions SHOULD support `token` and `debug` inputs.
  2. Bash-First: Prefer Composite Actions calling dedicated shell scripts (`action.sh`) for simple logic.
  3. Consistent Branding: Icons/Colors should reflect purpose (Build = blue, Fail/Alert = red).

About

Consolidated repo for bcgov-specific actions. Please feel free to contribute!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages