Skip to content

chore(deprecate): add deprecation warning and redirect README #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DerekRoberts wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore(deprecate): add deprecation warning and redirect README #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e49a4eb
chore(deprecate): add deprecation warning and redirect README
DerekRoberts Jul 3, 2026
262c0fe
fix: skip deprecated check if value is __OMITTED__
DerekRoberts Jul 4, 2026
1e70928
Revert "fix: skip deprecated check if value is __OMITTED__"
DerekRoberts Jul 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
233 changes: 7 additions & 226 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,229 +1,10 @@
**BREAKING CHANGES in v1.0:**
* **java_version is now required (previously defaulted to 17)**
* **sonar_project_token has been renamed sonar_token**
# ⚠️ THIS ACTION HAS MOVED

<!-- Badges -->
[![Issues](https://img.shields.io/github/issues/bcgov/action-test-and-analyse-java)](/../../issues)
[![Pull Requests](https://img.shields.io/github/issues-pr/bcgov/action-test-and-analyse-java)](/../../pulls)
[![MIT License](https://img.shields.io/github/license/bcgov/action-test-and-analyse-java.svg)](/LICENSE)
[![Lifecycle](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
This GitHub Action has been consolidated into the centralized `bcgov/actions` monorepo.

<!-- Reference-Style link -->
[SonarCloud]: https://sonarcloud.io
[Issues]: https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue
[Pull Requests]: https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request
### New Location
Please update your workflows to use the new location:
- **Action Reference:** `uses: bcgov/actions/test-and-analyse-java@vX.Y.Z`
- **Monorepo Link:** [bcgov/actions/test-and-analyse-java](https://github.com/bcgov/actions/tree/main/test-and-analyse-java)

# Test and Analyze with Triggers and SonarCloud

This action runs tests, dependent on triggers, optionally sending results and coverage to [SonarCloud](https://sonarcloud.io). Test and SonarCloud can be configured to comment on pull requests or stop failing workflows.

Conditional triggers are used to determine whether tests need to be run. If triggers are matched, then the appropriate code has changed and should be tested. Tests always run if no triggers are provided. Untriggered runs do little other than report a success.

Only Java is supported by this action. Please see our [JavaScript action](https://github.com/bcgov/action-test-and-analyse) or upcoming Python action as required.

# Usage

```yaml
- uses: bcgov/action-test-and-analyse-java@x.y.z
with:
### Required

# Commands to run unit tests
# Please configure your app to generate coverage (coverage/lcov.info)
commands: |
mvn -B verify -P all-tests checkstyle:checkstyle -Dcheckstyle.skip=false

# Project/app directory
dir: backend

# Java version, previously defaulted to 17 (LTS)
java-version: "17"

### Typical / recommended

# Java package manager cache, defaults to maven
java-cache: maven

# Java distribution, defaults to temurin
java-distribution: temurin

# Sonar arguments
# https://docs.sonarcloud.io/advanced-setup/analysis-parameters/
sonar_args: |
-Dsonar.exclusions=**/coverage/**
-Dsonar.organization=bcgov-sonarcloud
-Dsonar.projectKey=bcgov_${{ github.repository }}

# Sonar project token
# Available from sonarcloud.io or your organization administrator
# BCGov i.e. https://github.com/BCDevOps/devops-requests/issues/new/choose
# Provide an unpopulated token for pre-setup, section will be skipped
sonar_token:
description: ${{ secrets.SONAR_TOKEN }}

# Bash array to diff for build triggering
# Optional, defaults to nothing, which forces a build
triggers: ('frontend/')

### Usually a bad idea / not recommended

# Overrides the default branch to diff against
# Defaults to the default branch, usually `main`
diff_branch: ${{ github.event.repository.default_branch }}

# Repository to clone and process
# Useful for consuming other repos, like in testing
# Defaults to the current one
repository: ${{ github.repository }}

# Branch to clone and process
# Useful for consuming non-default branches, like in testing
# Defants to empty, cloning the default branch
branch: ""
```

# Example, Single Directory with SonarCloud Analysis

Run tests and provide results to SonarCloud. This is a full workflow that runs on pull requests, merge to main and workflow_dispatch. Use a GitHub Action secret to provide ${{ secrets.SONAR_TOKEN }}.

The specified triggers will be used to decide whether this job runs tests and analysis or just exists successfully.

Create or modify a GitHub workflow, like below. E.g. `./github/workflows/tests.yml`

Note: Provde an unpopulated SONAR_TOKEN until one is provisioned. SonarCloud will only run once populated, allowing for pre-setup.

```yaml
name: Analysis

on:
pull_request:
push:
branches: [main]
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
tests:
name: Unit Tests
runs-on: ubuntu-24.04
steps:
- uses: bcgov/action-test-and-analyse-java@x.y.z
with:
commands: |
./mvnw test
dir: frontend
java-cache: maven
java-distribution: temurin
java-version: "17"
sonar_args: |
-Dsonar.exclusions=**/coverage/**
-Dsonar.organization=bcgov-nr
-Dsonar.projectKey=bcgov-nr_action-test-and-analyse-java
sonar_token: ${{ secrets.SONAR_TOKEN }}
triggers: ('frontend/' 'charts/frontend')
```

# Example, Only Running Tests (No SonarCloud), No Triggers

No triggers are provided so tests will always run. SonarCloud is skipped.

```yaml
jobs:
tests:
name: Unit Tests
runs-on: ubuntu-24.04
steps:
- uses: bcgov/action-test-and-analyse-java@x.y.z
with:
commands: |
./mvnw test
dir: frontend
java-cache: maven
java-distribution: temurin
java-version: "17"
```

# Example, Matrix / Multiple Directories with Sonar Cloud and Triggers

Test projects in multiple directories in parallel. This time `repository` and `branch` are provided. Please note how secrets must be passed in to composite Actions using the secrets[matrix.variable] syntax.

```yaml
jobs:
tests:
name: Unit Tests
runs-on: ubuntu-24.04
strategy:
matrix:
dir: [backend, frontend]
include:
- dir: backend
token: SONAR_TOKEN_BACKEND
triggers: ('frontend/' 'charts/frontend')
- dir: frontend
token: SONAR_TOKEN_FRONTEND
triggers: ('backend/' 'charts/backend')
steps:
- uses: actions/checkout@v5
- uses: bcgov/action-test-and-analyse-java@x.y.z
with:
commands: |
./mvnw test
dir: ${{ matrix.dir }}
java-cache: maven
java-distribution: temurin
java-version: "17"
sonar_args: |
-Dsonar.exclusions=**/coverage/**
-Dsonar.organization=bcgov-nr
-Dsonar.projectKey=bcgov-nr_action-test-and-analyse-java_${{ matrix.dir }}
sonar_token: ${{ secrets[matrix.token] }}
triggers: ${{ matrix.triggers }}
repository: bcgov/quickstart-openshift
branch: main
```

# Outputs

| Output | Description |
| --------- | ------------------------------------------ |
| triggered | Whether the action was triggered based on path changes (true/false) |

Has the action been triggered by path changes? \[true|false\]

```yaml
- id: test
uses: bcgov/action-test-and-analyse-java@x.y.z
with:
commands: |
mvn -B verify -P all-tests checkstyle:checkstyle -Dcheckstyle.skip=false
dir: backend
java-version: "17"
triggers: ('backend/')

- if: steps.test.outputs.triggered == 'true'
run: echo "✅ Tests were triggered by path changes"

- if: steps.test.outputs.triggered == 'false'
run: echo "ℹ️ Tests were not triggered (no matching path changes)"
```

# Sonar Project Token

SonarCloud project tokens are free, available from [SonarCloud] or your organization's aministrators.

For BC Government projects, please create an [issue for our platform team](https://github.com/BCDevOps/devops-requests/issues/new/choose).

After sign up, a token should be available from your project on the [SonarCloud] site. Multirepo projects (e.g. backend, frontend) will have multiple projects. Click `Administration > Analysis Method > GitHub Actions (tutorial)` to find yours.

E.g. https://sonarcloud.io/project/configuration?id={<PROJECT>}&analysisMode=GitHubActions

# Feedback

Please contribute your ideas! [Issues] and [pull requests] are appreciated.

<!-- # Acknowledgements

This Action is provided courtesty of the Forestry Suite of Applications, part of the Government of British Columbia. -->
This repository is deprecated and will be archived.
5 changes: 5 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ outputs:
runs:
using: composite
steps:
- name: Deprecation warning
shell: bash
run: |
echo "::warning::This Action has moved to the centralized monorepo. Please update your workflow to use bcgov/actions/test-and-analyse-java instead."
Comment thread
DerekRoberts marked this conversation as resolved.

- name: Warnings for breaking changes
shell: bash
run: |
Expand Down
Loading