Skip to content

Make PHPBB_BRANCH optional #22

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

Merged
iMattPro merged 1 commit into from
May 4, 2025
Merged

Make PHPBB_BRANCH optional #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ on:
required: true
type: string
PHPBB_BRANCH:
required: true
required: false
default: '3.3.x'
type: string
SNIFF:
required: false
Expand Down
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,27 +46,24 @@ on:
jobs:
call-tests:
name: Extension tests
uses: phpbb-extensions/test-framework/.github/workflows/tests.yml@3.3.x # Must match PHPBB_BRANCH
uses: phpbb-extensions/test-framework/.github/workflows/tests.yml@3.3.x # The phpBB branch to run tests with
with:
EXTNAME: acme/demo # Your extension vendor/package name
PHPBB_BRANCH: 3.3.x # The phpBB branch to run tests on
secrets:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} # Do not edit or remove this
```

### Branches

Use the branch that matches the phpBB version you're developing for.
Use the test-framework branch that matches the phpBB version you're developing for:

- `3.3.x`: Targets the phpBB 3.3.x release line.
- `master`: Targets the latest development version of phpBB (`master` branch).

> ‼️ Whichever branch you choose here, be sure to use the **same value** for both the `PHPBB_BRANCH` and in the `uses:` line after the `@` symbol. For example, if you're targeting the `3.3.x` branch:
> ‼️ Whichever branch of this framework you choose, be sure it is appended to the `uses:` line after the `@` symbol. For example, if you're targeting the `3.3.x` branch:
>
> ```yaml
> uses: phpbb-extensions/test-framework/.github/workflows/tests.yml@3.3.x
> with:
> PHPBB_BRANCH: 3.3.x
> ```

### Requirements
Expand All @@ -84,11 +81,17 @@ call-tests:
uses: phpbb-extensions/test-framework/.github/workflows/tests.yml@3.3.x
with:
EXTNAME: acme/demo # Your extension vendor/package name
PHPBB_BRANCH: 3.3.x # The phpBB branch to run tests on

# OPTIONAL CONFIGURATIONS BELOW
# The following arguments are optional and can be omitted if not needed.

# The phpBB branch to use when running tests.
# Default is '3.3.x', which this framework is designed for.
# If using a different branch, ensure it's compatible with 3.3.x.
# To test with phpBB's master branch, refer to the Branches section of this README.
# Default: '3.3.x'
PHPBB_BRANCH: '3.3.x'

# Run phpBB's EPV (Extension Pre Validator)? 1 (yes) or 0 (no)
# Default: 1
EPV: 1
Expand Down