forked from reanahub/reana-github-actions
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(docs): move from reST to Markdown (reanahub#8)
Convert docs from reStructuredText to Markdown so that the changelog file is compatible with Release Please.
- Loading branch information
Showing
5 changed files
with
68 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Authors | ||
|
||
The list of contributors in alphabetical order: | ||
|
||
- [Marco Donadoni](https://orcid.org/0000-0003-2922-5505) | ||
- [Marco Vidal](https://orcid.org/0000-0002-9363-4971) | ||
- [Tibor Simko](https://orcid.org/0000-0001-7202-5803) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Changelog | ||
|
||
## 1.1.1 (2023-12-06) | ||
|
||
- Changes the `release-docker` action to disable provenance and SBOM attestations. | ||
|
||
## 1.1.0 (2023-11-15) | ||
|
||
- Adds the `release-docker` action to automatically publish Docker images. | ||
|
||
## 1.0.1 (2023-08-16) | ||
|
||
- Changes the `local-validate` and `local-run` actions to update the dependent Checkout and Python sub-actions to their latest versions. | ||
|
||
## 1.0.0 (2021-10-11) | ||
|
||
- Adds the `local-validate` action to validate REANA specification files. | ||
- Adds the `local-run` action to run workflows. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,44 @@ | ||
# reana-github-actions | ||
REANA GitHub Actions. | ||
# REANA-GitHub-Actions | ||
|
||
[How to create composite actions](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) | ||
[![image](https://github.com/reanahub/reana-github-actions/workflows/CI/badge.svg)](https://github.com/reanahub/reana-github-actions/actions) | ||
[![image](https://img.shields.io/badge/discourse-forum-blue.svg)](https://forum.reana.io) | ||
[![image](https://img.shields.io/github/license/reanahub/reana-github-actions.svg)](https://github.com/reanahub/reana-github-actions/blob/master/LICENSE) | ||
|
||
## About | ||
|
||
REANA-GitHub-Actions provides CI actions that can be used in multiple GitHub repositories. | ||
|
||
## Features | ||
|
||
- validate the REANA specification file of demo examples | ||
- execute demo examples | ||
- build and publish the container images of REANA's cluster components | ||
|
||
## Usage | ||
|
||
To use one of the actions, simply reference it from the YAML specification file of the CI workflow. | ||
For example, to validate the `reana.yaml` file of a demo example, you can add the following job to the workflow: | ||
|
||
```yaml | ||
validate: | ||
runs-on: ubuntu-20.04 | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
|
||
- name: Validate workflow spec | ||
uses: reanahub/reana-github-actions/local-validate@v1 | ||
with: | ||
reana_specs: reana.yaml | ||
``` | ||
To find out which inputs are accepted by each action, please have a look at the corresponding `action.yml` file. | ||
|
||
## Useful links | ||
|
||
- [How to create composite actions](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) | ||
- [REANA project home page](http://www.reana.io/) | ||
- [REANA user documentation](https://docs.reana.io) | ||
- [REANA user support forum](https://forum.reana.io) | ||
- [REANA-GitHub-Actions known issues](https://github.com/reanahub/reana-message-broker/issues) | ||
- [REANA-GitHub-Actions source code](https://github.com/reanahub/reana-message-broker) |