Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
root = true

[*]
charset = utf-8
end_of_line = lf
indent_style = space
insert_final_newline = true
trim_trailing_whitespace=true

[*.{css,html,js,json,scss,yaml,yml}]
indent_size = 2

[*.{py,sh}]
indent_size = 4

[*.go]
indent_style = tab
155 changes: 104 additions & 51 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,109 +4,162 @@
# REANA is free software; you can redistribute it and/or modify it
# under the terms of the MIT License; see LICENSE file for more details

name: CI
name: ci

on: [push, pull_request]

jobs:
lint-commitlint:
shell-completions:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Go
uses: actions/setup-go@v5
with:
fetch-depth: 0
go-version: "1.25.8"

- name: Setup Node
uses: actions/setup-node@v4
- name: Check shell completions are up-to-date
run: ./run-tests.sh --shell-completions

- name: Install commitlint
run: |
npm install conventional-changelog-conventionalcommits
npm install commitlint@latest
format-go:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Check commit message compliance of the recently pushed commit
if: github.event_name == 'push'
run: |
./run-tests.sh --check-commitlint HEAD~1 HEAD
- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: "1.25.8"

- name: Check commit message compliance of the pull request
if: github.event_name == 'pull_request'
run: |
./run-tests.sh --check-commitlint ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} ${{ github.event.pull_request.number }}
- name: Check Go code formatting
run: ./run-tests.sh --format-go

lint-shellcheck:
format-prettier:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Runs shell script static analysis
- name: Setup Node
uses: actions/setup-node@v4

- name: Check Prettier code formatting
run: |
sudo apt-get install shellcheck
./run-tests.sh --check-shellcheck
npm install prettier --global
./run-tests.sh --format-prettier

check-shell-completions:
format-shfmt:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.25.7'

- name: Check shell completions are up-to-date
- name: Check shell script code formatting
run: |
./run-tests.sh --check-shell-completions
sudo apt-get install shfmt
./run-tests.sh --format-shfmt

go-tests:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Checkout
uses: actions/checkout@v4

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.25.7'
go-version: "1.25.8"

- name: Run test suite
run: make test
- name: Run Go test suite
run: ./run-tests.sh --go-tests

- name: Codecov Coverage
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}

go-tidy:
lint-commitlint:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Node
uses: actions/setup-node@v4

- name: Install commitlint
run: |
npm install conventional-changelog-conventionalcommits
npm install commitlint@latest

- name: Check commit message compliance of the recently pushed commit
if: github.event_name == 'push'
run: |
./run-tests.sh --lint-commitlint HEAD~1 HEAD

- name: Check commit message compliance of the pull request
if: github.event_name == 'pull_request'
run: |
./run-tests.sh --lint-commitlint ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} ${{ github.event.pull_request.number }}

lint-goaudit:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.25.7'
go-version: "1.25.8"

- name: Check code formatting
- name: Run Go audit checks
run: ./run-tests.sh --lint-goaudit

lint-markdownlint:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v4

- name: Lint Markdown files
run: |
make tidy
if [[ -n $(git status --porcelain) ]]; then
echo "Code is not properly formatted. Please run 'make tidy' locally."
git diff
exit 1
fi

go-audit:
npm install markdownlint-cli2 --global
./run-tests.sh --lint-markdownlint

lint-shellcheck:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Checkout
uses: actions/checkout@v4

- name: Setup Go
uses: actions/setup-go@v5
- name: Runs shell script static analysis
run: |
sudo apt-get install shellcheck
./run-tests.sh --lint-shellcheck

lint-yamllint:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@v4
with:
go-version: '1.25.7'
fetch-depth: 0

- name: Run audit checks
run: make audit
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Lint YAML files
run: |
pip install yamllint
./run-tests.sh --lint-yamllint
2 changes: 2 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Allow prompt dollar sign in console examples without showing output
MD014: false
2 changes: 1 addition & 1 deletion .mise.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
[tools]
go = "1.25.7"
go = "1.25.8"
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.pytest_cache
CHANGELOG.md
2 changes: 2 additions & 0 deletions .prettierrc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
printWidth: 80
proseWrap: always
7 changes: 7 additions & 0 deletions .yamllint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: default
rules:
comments:
min-spaces-from-content: 1
document-start: disable
line-length: disable
truthy: disable
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Contributing

Bug reports, issues, feature requests, and other contributions are welcome. If you find
a demonstrable problem that is caused by the REANA code, please:
Bug reports, issues, feature requests, and other contributions are welcome. If
you find a demonstrable problem that is caused by the REANA code, please:

1. Search for [already reported problems](https://github.com/reanahub/reana-client-go/issues).
2. Check if the issue has been fixed or is still reproducible on the
latest `master` branch.
1. Search for
[already reported problems](https://github.com/reanahub/reana-client-go/issues).
2. Check if the issue has been fixed or is still reproducible on the latest
`master` branch.
3. Create an issue, ideally with **a test case**.

If you create a pull request fixing a bug or implementing a feature, you can run
Expand Down
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,19 @@
[![image](https://img.shields.io/badge/discourse-forum-blue.svg)](https://forum.reana.io)
[![image](https://img.shields.io/github/license/reanahub/reana.svg)](https://github.com/reanahub/reana-client-go/blob/master/LICENSE)

# About
## About

REANA-Client-Go is a component of the [REANA](https://www.reana.io/) reusable and
reproducible research data analysis platform. It provides a command-line tool that allows
researchers to submit, run, and manage their computational workflows.
REANA-Client-Go is a component of the [REANA](https://www.reana.io/) reusable
and reproducible research data analysis platform. It provides a command-line
tool that allows researchers to submit, run, and manage their computational
workflows.

- seed workspace with input code and data
- run computational workflows on remote compute clouds
- list submitted workflows and enquire about their statuses
- download results of finished workflows

# Usage
## Usage

The detailed information on how to install and use REANA can be found in
[docs.reana.io](https://docs.reana.io).
Expand All @@ -40,7 +41,7 @@ source <(reana-client-go completion zsh)
compdef _reana-client-go reana-client-go
```

# Useful links
## Useful links

- [REANA project home page](http://www.reana.io/)
- [REANA user documentation](https://docs.reana.io)
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module reanahub/reana-client-go

go 1.25.7
go 1.25.8

require (
github.com/go-gota/gota v0.12.0
Expand Down
Loading
Loading