actions-marketplace-validations/Project context
Build project context and synchronize project version
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Aug 5, 2024
- License
- Apache 2.0
Pinned Snippet
uses: actions-marketplace-validations/zero88_gh-project-context@f18a0d15c231ca76c18ab18c131a19500bb7d88f # no releases — HEAD as of 2026-07-10tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| defaultBranch | Project default branch | no | main |
| tagPrefix | Git Tag Prefix | no | v |
| hotfixPrefix | Git Hotfix Prefix | no | hotfix/ |
| releaseBranchPrefix | Git Release Branch Prefix | no | release/ |
| mergedReleaseMsgRegex | Merged release message regex | no | ^Merge pull request #[0-9]+ from .+/release/.+$ |
| patterns | Project patterns to search/replace version. Format: <glob_pattern_with_ext>::<version_regex>::<regex_group> | no | pyproject.toml::(version\s?=\s?)(")([^"]+)(")::2 package?(-lock).json::("version"\s?:\s?)(")([^"]+)(")::2 @(gradle|maven|pom|project).properties::(version\s?=\s?)(.+)::1 @(application|version).yml::(version:\s)(.+)::1 @(VERSION|version)?(.txt)::.+::0 |
| shaLength | Create output short commit id within length. Default is 7 | no | 7 |
| allowCommit | CI: Allow git commit to fix version if not match | no | true |
| allowTag | CI: Allow git tag if merged release branch | no | true |
| userName | CI: Username to commit. Skip if any config visible in Runner git config | no | ci-bot |
| userEmail | CI: User email to commit. Skip if any config visible in Runner git config | no | actions@github.com |
| mustSign | CI: Required GPG sign when git commit/tag | no | false |
| prefixCiMsg | CI: Prefix bot message | no | <ci-auto-commit> |
| correctVerMsg | CI: Correct version commit message template | no | Correct version |
| releaseVerMsg | CI: Release version commit message template | no | Release version |
| nextVerMsg | CI: Next version commit message template | no | Next version |
| nextVerMode | CI: Next version mode to choose for upgrading version after merged release PR. One of: MAJOR|MINOR|PATCH|NONE | no | NONE |
| token | GitHub token to query GitHub API, that is used in changelog generator and Pull Request creator | no | — |
| dry | CI: Dry run. If `true`, action will run without do modify files or git commit/tag | yes | false |
| changelog | Enable generate CHANGELOG | no | false |
| changelogImage | CHANGELOG docker image tag: https://github.com/github-changelog-generator/docker-github-changelog-generator | no | githubchangeloggenerator/github-changelog-generator:1.16.2 |
| changelogConfigFile | CHANGELOG config file: https://github.com/github-changelog-generator/github-changelog-generator#params-file | no | .github_changelog_generator |
| changelogToken | CHANGELOG token to query GitHub API: https://github.com/github-changelog-generator/github-changelog-generator#github-token | no | — |
| changelogMsg | CI: Changelog generator commit message template | no | Generated CHANGELOG |
Outputs
| name | description |
|---|---|
| branch | Current branch name or tag name |
| onDefaultBranch | Check whether current event is on default branch or not |
| onRelease | Check whether current event is on default branch or not |
| isBranch | Check whether current event is on branch or not |
| isPR | Check whether current event is on pull request or not |
| isTag | Check whether current event is on ref tag |
| isSchedule | Check whether current event is by schedule or not |
| isDispatch | Check whether current event is by manual or dispatch from another workflow or event from repository |
| isRelease | Check whether current event is release event on regardless of branch, pull-request or tag |
| isHotfix | Check whether current event is hotfix event on regardless of branch, pull-request or tag |
| isAfterMergedReleasePR | Check whether current event is a merged commit after merged release pull request into default branch or not |
| isMerged | Check whether current event is merged PR |
| isClosed | Check whether current event is close PR but not merged into target branch |
| isOpened | Check whether current event is open PR or create branch |
| prBaseBranch | Base branch in pull request |
| commitMsg | The latest commit message |
| commitId | The latest commit id |
| commitShortId | The latest short commit id |
| version | Current tag version or release version |
| ci_mustFixVersion | CI: Need to fix version to match with release name |
| ci_needPullRequest | CI: Need to open new pull request for release or merge hotfix into default branch |
| ci_needTag | CI: Need to tag new version if release branch is merged |
| ci_needUpgrade | CI: Need to upgrade next version after release branch is merged into default branch |
| ci_isPushed | CI: Check whether if auto commit is pushed to remote |
| ci_commitId | CI: auto commit id |
| ci_commitMsg | CI: auto commit message |
| ci_changelog_generated | CI: changelog is generated |
| ci_changelog_releaseTag | CI: changelog generated for release tag |
| ci_changelog_sinceTag | CI: changelog generated since tag |
| ci_changelog_isCommitted | CI: changelog is committed |
| ci_changelog_commitId | CI: changelog auto commit id |
| ci_changelog_commitMsg | CI: changelog auto commit message |
| decision_build | Should run the next step: such as build & test Default value is: `!(ciPushed || isClosed || isMerged || (isBranch && (isRelease || isOpened)) || isAfterMergedReleasePR)` |
| decision_publish | Should publish artifact: such as push artifact to any registry: npm, docker, maven, pypi.. Default value is: `decision.build && (onDefaultBranch || (isRelease && isTag))` |
| ver_current | Current version in configuration file or tag/release version |
| ver_bumped | Bumped version |
| ver_nextMajor | Suggest next major version if after release and ver_current is compatible with semver |
| ver_nextMinor | Suggest next minor version if after release and ver_current is compatible with semver |
| ver_nextPatch | Suggest next patch version if after release and ver_current is compatible with semver |