Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
NxPKG committed Sep 5, 2024
1 parent 0820c35 commit 8ff6f12
Show file tree
Hide file tree
Showing 19 changed files with 1,053 additions and 1,451 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
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
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
# Note: this file originates in template-template #
# ----------------------------------------------- #

github: [khulnasoft-bot]
github: [khulnasoft]
24 changes: 18 additions & 6 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,29 @@
# ----------------------------------------------- #
# Note: this file originates in template-template #
# ----------------------------------------------- #
# ---------------------------------------------------- #
# Note: this file originates in template-action-docker #
# ---------------------------------------------------- #

version: 2
updates:
- package-ecosystem: github-actions
- package-ecosystem: npm
open-pull-requests-limit: 10
directory: /action
commit-message:
prefix: build
prefix-development: chore
include: scope
schedule:
interval: daily
time: "10:00"
timezone: America/Toronto

- package-ecosystem: docker
open-pull-requests-limit: 10
directory: /
commit-message:
prefix: chore
prefix: build
prefix-development: chore
include: scope
schedule:
interval: daily
time: "10:00"
timezone: Astana/Dhaka
timezone: America/Toronto
1 change: 1 addition & 0 deletions .github/linters/.lychee.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
exclude_path = [".github"]
21 changes: 0 additions & 21 deletions .github/template-sync.yml

This file was deleted.

98 changes: 0 additions & 98 deletions .github/workflows/docker-publish.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/pull_request_target.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ permissions: read-all

jobs:
main:
uses: khulnasoft/actions/.github/workflows/pull-request-target-template.yml@master
uses: khulnasoft/actions/.github/workflows/pull-request-target.yml@master
secrets: inherit
9 changes: 5 additions & 4 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ----------------------------------------------- #
# Note: this file originates in template-template #
# ----------------------------------------------- #
# ---------------------------------------------------- #
# Note: this file originates in template-action-docker #
# ---------------------------------------------------- #

name: push

Expand All @@ -12,9 +12,10 @@ permissions: read-all

jobs:
main:
uses: khulnasoft/actions/.github/workflows/push-template.yml@master
uses: khulnasoft/actions/.github/workflows/push-action-docker.yml@master
secrets: inherit
permissions:
contents: write
statuses: write
packages: write
pull-requests: write
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 KhulnaSoft Ltd.
Copyright (c) 2020 KhulnaSoft Ltd <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
78 changes: 41 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# Template GitHub Composite Actions
# GitHub Action: Semantic Release

A template for GitHub Template GitHub Composite Actions
semantic-release as a GitHub Action, with all presets included

[![license][license-img]][license-url]
[![release][release-img]][release-url]
[![semantic][semantic-img]][semantic-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 @@ -26,49 +27,49 @@ jobs:
uses: actions/checkout@v2

- name: semantic-release
uses: khulnasoft-lab/action-semantic-release@master
uses: khulnasoft-lab/action-semantic-release@v2
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
### 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 All @@ -77,10 +78,13 @@ jobs:

----
> Author: [KhulnaSoft Ltd](https://www.khulnasoft.com/) &bull;
> Twitter: [@KhulnaSoft](https://twitter.com/khulnasoft)
> Twitter: [@khulnasoft](https://twitter.com/khulnasoft)

[license-url]: LICENSE
[license-img]: https://badgen.net/github/license/khulnasoft-lab/action-semantic-release

[release-url]: https://github.com/khulnasoft-lab/action-semantic-release/releases
[release-img]: https://badgen.net/github/release/khulnasoft-lab/action-semantic-release

[semantic-url]: https://github.com/khulnasoft-lab/action-semantic-release/actions?query=workflow%3Arelease
[semantic-img]: https://badgen.net/badge/📦/semantically%20released/blue
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ branding:

runs:
using: docker
image: docker://ghcr.io/khulnasoft-lab/action-semantic-release:latest
image: docker://ghcr.io/khulnasoft-lab/action-semantic-release:2.2.8

inputs:
dry:
Expand Down
6 changes: 3 additions & 3 deletions colophon.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
version: 2.0

id: action-composite-template
id: action-semantic-release

about:
title: Template GitHub Composite Actions
description: A template for GitHub Template GitHub Composite Actions
title: "GitHub Action: Semantic Release"
description: semantic-release as a GitHub Action, with all presets included
repository: khulnasoft-lab/action-semantic-release
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ services:
# ---- readme generator ---- #
readme:
profiles: ["dev"]
image: pandoc/minimal:3.2
image: pandoc/minimal:2.19
volumes:
- ./:/data
command: --defaults=.pandoc.yml
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
uses: actions/checkout@v2

- name: semantic-release
uses: khulnasoft-lab/action-semantic-release@master
uses: khulnasoft-lab/action-semantic-release@v2
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion docs/README.template
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ $body$

----
> Author: [KhulnaSoft Ltd](https://www.khulnasoft.com/) &bull;
> Twitter: [@KhulnaSoft](https://twitter.com/khulnasoft)
> Twitter: [@khulnasoft](https://twitter.com/khulnasoft)

[license-url]: LICENSE
[license-img]: https://badgen.net/github/license/$about.repository$
Expand Down
Loading

0 comments on commit 8ff6f12

Please sign in to comment.