From 100ba335cd748f350c714fa47409d4f1f8be8034 Mon Sep 17 00:00:00 2001 From: Paul Hewlett Date: Fri, 21 May 2021 10:54:22 +0100 Subject: [PATCH 1/2] Add all necessary bolerplate --- .github/workflows/shell-check.yml | 18 ++++++++++++++ BUILDING.md | 24 +++++++++++++++++++ CODE_OF_CONDUCT.md | 40 +++++++++++++++++++++++++++++++ DCO | 38 +++++++++++++++++++++++++++++ README.md | 4 +++- Taskfile.yml | 13 ++++++++++ scripts/example.sh | 5 ++++ 7 files changed, 141 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/shell-check.yml create mode 100644 BUILDING.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 DCO create mode 100644 Taskfile.yml create mode 100644 scripts/example.sh diff --git a/.github/workflows/shell-check.yml b/.github/workflows/shell-check.yml new file mode 100644 index 0000000..7a30596 --- /dev/null +++ b/.github/workflows/shell-check.yml @@ -0,0 +1,18 @@ + +on: + push: + branch: + - main + +name: 'Trigger: Push action' + +jobs: + shellcheck: + name: Shellcheck + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Run ShellCheck + uses: ludeeus/action-shellcheck@master + with: + scandir: './scripts' diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000..c654cf1 --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,24 @@ +# Jitsuin Archivist Shell Development + +## Pre-requisites + +Required tools for this repo are task-runner and shellcheck. + +Install task runner: https://github.com/go-task/task +Install shellcheck: https://github.com/koalaman/shellcheck#user-content-installing + +## Workflow + +To see what options are available simply execute: + +```bash +task +``` + +Make a change to the code and validate the changes: + +```bash +task check +``` + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..37553e8 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,40 @@ +Jitsuin observes the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md), reproduced below for emphasis. + +### Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of fostering +an open and welcoming community, we pledge to respect all people who contribute +through reporting issues, posting feature requests, updating documentation, +submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free experience for +everyone, regardless of level of experience, gender, gender identity and expression, +sexual orientation, disability, personal appearance, body size, race, ethnicity, age, +religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing others' private information, such as physical or electronic addresses, + without explicit permission +* Other unethical or unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are not +aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers +commit themselves to fairly and consistently applying these principles to every aspect +of managing this project. Project maintainers who do not follow or enforce the Code of +Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a Jitsuin administrator on . + +This Code of Conduct is adapted from the Contributor Covenant +(http://contributor-covenant.org), version 1.2.0, available at +http://contributor-covenant.org/version/1/2/0/ + diff --git a/DCO b/DCO new file mode 100644 index 0000000..912d22e --- /dev/null +++ b/DCO @@ -0,0 +1,38 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. + diff --git a/README.md b/README.md index 3454e0b..dd31cfa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ # archivist-shell -Repository for convenience scripts for the Jitsin Archivst system + +Repository for convenience scripts for the Jitsuin Archivist system + diff --git a/Taskfile.yml b/Taskfile.yml new file mode 100644 index 0000000..8e04667 --- /dev/null +++ b/Taskfile.yml @@ -0,0 +1,13 @@ +version: '3' + +tasks: + + check: + desc: Standard linting of shell scripts + cmds: + - shellcheck scripts/*.sh + + clean: + desc: Clean git repo + cmds: + - git clean -fdX diff --git a/scripts/example.sh b/scripts/example.sh new file mode 100644 index 0000000..9282bdf --- /dev/null +++ b/scripts/example.sh @@ -0,0 +1,5 @@ +#!/bin/bash +# +# Example script to just prove all the github hooks and actions work +# +echo "Running example script - please delete me once other scripts have been added" From b18396ef8d8d3069885c0979035dbebad2fa5555 Mon Sep 17 00:00:00 2001 From: Paul Hewlett Date: Fri, 21 May 2021 11:17:53 +0100 Subject: [PATCH 2/2] fixup! Add all necessary bolerplate --- BUILDING.md | 24 ------------------------ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 24 insertions(+), 24 deletions(-) delete mode 100644 BUILDING.md diff --git a/BUILDING.md b/BUILDING.md deleted file mode 100644 index c654cf1..0000000 --- a/BUILDING.md +++ /dev/null @@ -1,24 +0,0 @@ -# Jitsuin Archivist Shell Development - -## Pre-requisites - -Required tools for this repo are task-runner and shellcheck. - -Install task runner: https://github.com/go-task/task -Install shellcheck: https://github.com/koalaman/shellcheck#user-content-installing - -## Workflow - -To see what options are available simply execute: - -```bash -task -``` - -Make a change to the code and validate the changes: - -```bash -task check -``` - - diff --git a/README.md b/README.md index dd31cfa..9261464 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,27 @@ Repository for convenience scripts for the Jitsuin Archivist system +# Development + +## Pre-requisites + +Required tools for this repo are task-runner and shellcheck. + +Install task runner: https://github.com/go-task/task +Install shellcheck: https://github.com/koalaman/shellcheck#user-content-installing + +## Workflow + +To see what options are available simply execute: + +```bash +task +``` + +Make a change to the code and validate the changes: + +```bash +task check +``` + +