diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..59a950f --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,33 @@ +--- +name: 'Lint' + +on: + pull_request: + branches: + - 'master' + paths: + - '**.sh' + - '**.md' + +jobs: + shellcheck: + name: 'ShellCheck' + runs-on: 'ubuntu-latest' + steps: + - uses: 'actions/checkout@v2' + - name: 'Run shellcheck' + uses: 'azohra/shell-linter@master' + with: + path: '*.sh' + env: + SHELLCHECK_OPTS: '-x' + markdown-lint: + name: 'Markdown Lint' + runs-on: 'ubuntu-latest' + steps: + - uses: 'actions/checkout@v2' + - name: 'Run markdownlint' + uses: 'avto-dev/markdown-lint@master' + with: + args: '.' + config: '.markdownlint.yml' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..5d6aeb1 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,23 @@ +--- +name: 'Release' + +on: + push: + tags: + - 'v*' + +jobs: + publish: + name: 'Publish' + runs-on: 'ubuntu-latest' + steps: + - uses: 'actions/checkout@v2' + - name: 'Create GitHub Release' + uses: 'anton-yurchenko/git-release@v3.4.2' + env: + GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' + DRAFT_RELEASE: 'false' + PRE_RELEASE: 'false' + CHANGELOG_FILE: 'CHANGELOG.md' + ALLOW_EMPTY_CHANGELOG: 'false' + ALLOW_TAG_PREFIX: 'true' diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml deleted file mode 100644 index 53e12b1..0000000 --- a/.github/workflows/shellcheck.yml +++ /dev/null @@ -1,10 +0,0 @@ -name: Shellcheck - -on: [push] - -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: ludeeus/action-shellcheck@0.1.0 diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000..02907b2 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,2 @@ +--- +MD013: false diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..fec6a11 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [1.0.0] - 2020-11-02 + +Final release supporting FreeNAS 11.3! + +### Added + +- 3 system reports scripts (SMART, ZPool and UPS) +- 1 config backup script +- 2 information gathering script (CPU & drives temperature as well as drives identification) +- A standalone bash function to format emails to be sent by the FreeNAS sendmail program + +[Unreleased]: https://github.com/PlqnK/freenas-useful-scripts/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/PlqnK/freenas-useful-scripts/releases/tag/v1.0.0