Skip to content

Commit

Permalink
Link to bento from README (#4)
Browse files Browse the repository at this point in the history
* Link to bento

* Use ?? over typeof

* Update format action

* Format code

* Update CHANGELOG
  • Loading branch information
razor-x authored Sep 10, 2024
1 parent db795ff commit 1cad6a5
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 13 deletions.
16 changes: 9 additions & 7 deletions .github/workflows/format.yml
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
---
name: format
name: Format

on:
push:
branches-ignore:
- master
- main
workflow_dispatch: {}

jobs:
fix:
commit:
name: Format code
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
token: ${{ secrets.GH_TOKEN }}
- name: Import GPG key
uses: crazy-max/ghaction-import-gpg@v5
uses: crazy-max/ghaction-import-gpg@v6
with:
git_user_signingkey: true
git_commit_gpgsign: true
Expand All @@ -31,9 +32,10 @@ jobs:
- name: Format
run: npm run format
- name: Commit
uses: stefanzweifel/git-auto-commit-action@v4
uses: stefanzweifel/git-auto-commit-action@v5
if: always()
with:
commit_message: Run format
commit_message: Format code
commit_user_name: ${{ secrets.GIT_USER_NAME }}
commit_user_email: ${{ secrets.GIT_USER_EMAIL }}
commit_author: ${{ secrets.GIT_USER_NAME }} <${{ secrets.GIT_USER_EMAIL }}>
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/)
and this project adheres to [Semantic Versioning](https://semver.org/).

## 1.3.0 / 2024-09-09

### Added

- New config option `checksumPrefix` to support compatible distributions like Bento.

## 1.2.4 / 2022-11-28

- No changes.
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,20 +148,22 @@ you can use the `include` property,

#### Bento support

If you need Serverless Bento, you can change `src` and `checksumPrefix` properties:
If you need Serverless [Bento], set the `src` and `checksumPrefix` properties,

```json
{
"blobpack": {
"name": "benthos-lambda",
"version": "4.10.0",
"version": "1.2.0",
"platform": "linux_amd64",
"checksumPrefix": "bento",
"src": "https://github.com/warpstreamlabs/bento/releases/download"
}
}
```

[Bento]: https://warpstreamlabs.github.io/bento/

### CLI

```
Expand Down
7 changes: 3 additions & 4 deletions lib/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@ export const loadConfig = async (configPath) => {
)
}

if (typeof config.checksumPrefix === 'undefined') {
config.checksumPrefix = 'benthos'
return {
...config,
checksumPrefix: config.checksumPrefix ?? 'benthos'
}

return config
}

export const loadJson = async (name) => {
Expand Down

0 comments on commit 1cad6a5

Please sign in to comment.