Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
@NxPKG
NxPKG committed Sep 5, 2024
1 parent 658d78f commit ec2fea1
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ trim_trailing_whitespace = true
trim_trailing_whitespace = false

[Makefile]
indent_style = tab
indent_style = tab
66 changes: 33 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ A template for GitHub Template GitHub Composite Actions
[![license][license-img]][license-url]
[![release][release-img]][release-url]

[`semantic-release`][] as a GitHub Action, with **all** presets included.
[`semantic-release`] as a GitHub Action, with **all** presets included.

- works with environment variables as documented in [`semantic-release` docs][]
- customizable through [`semantic-release` configuration file][]
- works with environment variables as documented in [`semantic-release` docs]
- customizable through [`semantic-release` configuration file]

## Usage

Expand All @@ -34,41 +34,41 @@ jobs:
### Inputs
| input | required | default | description |
|------------|----------|--------------|------------------------------------------------------------------|
| `config` | ❌ | [see docs][] | File path to configuration file |
| `dry` | ❌ | `false` | Execute in "dry-run" mode |
| `debug` | ❌ | `false` | Output debugging information |
| `format` | ❌ | [see docs][] | The Git tag format used by semantic-release to identify releases |
| `branches` | ❌ | [see docs][] | The branches on which releases should happen |
| input | required | default | description |
|----|----|----|----|
| `config` | ❌ | [see docs] | File path to configuration file |
| `dry` | ❌ | `false` | Execute in "dry-run" mode |
| `debug` | ❌ | `false` | Output debugging information |
| `format` | ❌ | [see docs] | The Git tag format used by semantic-release to identify releases |
| `branches` | ❌ | [see docs] | The branches on which releases should happen |

> ⚠️ ***Note**: only use `config` if you're using a non-standard [configuration file name][`semantic-release` configuration file] and in **JSON format***

### Outputs

| output | example | description |
|--------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------|
| `published` | `true` | `'true'` when release is successfully published, `'false'` when nothing is published |
| `last-release-git-head` | `d80709` | The sha of the last commit being part of the last release |
| `last-release-git-tag` | `v1.0.0` | The Git tag associated with the last release |
| `last-release-channel` | `next` | The distribution channel on which the last release was initially made available *(`null` for the default distribution channel)* |
| `last-release-version` | `1.0.0` | The version of the last release |
| `last-release-version-major` | `1` | last release version major component |
| `last-release-version-minor` | `0` | last release version minor component |
| `last-release-version-patch` | `0` | last release version patch component |
| `last-release-version-prerelease` | `-` | last release version prerelease component |
| `last-release-version-buildmetadata` | `-` | last release version buildmetadata component |
| `release-type` | `major` | The semver type of the release (patch, minor or major) |
| `release-git-head` | `d494d2` | The sha of the last commit being part of the new release |
| `release-git-tag` | `v1.1.0` | The Git tag associated with the new release |
| `release-version` | `1.1.0` | The version of the new release. |
| `release-notes` | `...` | The release notes for the new release |
| `release-channel` | `next` | The distribution channel on which the next release will be made available *(`null` for the default distribution channel)* |
| `release-version-major` | `1` | last release version major component |
| `release-version-minor` | `1` | last release version minor component |
| `release-version-patch` | `0` | last release version patch component |
| `release-version-prerelease` | `-` | last release version prerelease component |
| `release-version-buildmetadata` | `-` | last release version buildmetadata component |
| output | example | description |
|----|----|----|
| `published` | `true` | `'true'` when release is successfully published, `'false'` when nothing is published |
| `last-release-git-head` | `d80709` | The sha of the last commit being part of the last release |
| `last-release-git-tag` | `v1.0.0` | The Git tag associated with the last release |
| `last-release-channel` | `next` | The distribution channel on which the last release was initially made available *(`null` for the default distribution channel)* |
| `last-release-version` | `1.0.0` | The version of the last release |
| `last-release-version-major` | `1` | last release version major component |
| `last-release-version-minor` | `0` | last release version minor component |
| `last-release-version-patch` | `0` | last release version patch component |
| `last-release-version-prerelease` | `-` | last release version prerelease component |
| `last-release-version-buildmetadata` | `-` | last release version buildmetadata component |
| `release-type` | `major` | The semver type of the release (patch, minor or major) |
| `release-git-head` | `d494d2` | The sha of the last commit being part of the new release |
| `release-git-tag` | `v1.1.0` | The Git tag associated with the new release |
| `release-version` | `1.1.0` | The version of the new release. |
| `release-notes` | `...` | The release notes for the new release |
| `release-channel` | `next` | The distribution channel on which the next release will be made available *(`null` for the default distribution channel)* |
| `release-version-major` | `1` | last release version major component |
| `release-version-minor` | `1` | last release version minor component |
| `release-version-patch` | `0` | last release version patch component |
| `release-version-prerelease` | `-` | last release version prerelease component |
| `release-version-buildmetadata` | `-` | last release version buildmetadata component |

[`semantic-release`]: https://semantic-release.gitbook.io/
[`semantic-release` docs]: https://semantic-release.gitbook.io/semantic-release/usage/ci-configuration#authentication
Expand Down
2 changes: 1 addition & 1 deletion src/entrypoint.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
git config --global --add safe.directory "${GITHUB_WORKSPACE:=.}"

# normal execution
node --no-warnings=ExperimentalWarnings /action/index.js
node --no-warnings=ExperimentalWarnings /action/index.js
2 changes: 1 addition & 1 deletion src/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ core.setOutput('release-version-major', nextRelease.parsed.groups.major)
core.setOutput('release-version-minor', nextRelease.parsed.groups.minor)
core.setOutput('release-version-patch', nextRelease.parsed.groups.patch)
core.setOutput('release-version-prerelease', nextRelease.parsed.groups.prerelease)
core.setOutput('release-version-buildmetadata', nextRelease.parsed.groups.buildmetadata)
core.setOutput('release-version-buildmetadata', nextRelease.parsed.groups.buildmetadata)

0 comments on commit ec2fea1

Please sign in to comment.