action/action.yml at main · stencila/action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
name: 'Stencila Action'
description: 'Setup Stencila CLI in GitHub Actions workflows to lint, release, and push executable documents'
author: 'Stencila'
branding:
  icon: 'file-text'
  color: 'blue'

inputs:
  version:
    description: 'Version of Stencila CLI to install (e.g., "latest", "2.0.0")'
    required: false
    default: 'latest'
  run:
    description: 'Stencila command and arguments to run (e.g., "lint report.smd", "render --to=md *.smd")'
    required: false
  convert:
    description: 'Run "stencila convert" with these arguments'
    required: false
  lint:
    description: 'Run "stencila lint" with these arguments'
    required: false
  execute:
    description: 'Run "stencila execute" with these arguments'
    required: false
  render:
    description: 'Run "stencila render" with these arguments'
    required: false
  assets:
    description: 'Path pattern for assets files to store after each run (e.g., "*.pdf", "output/**/*")'
    required: false
  releases:
    description: 'Enable releases on tags. Set to true to use assets pattern, or provide a custom pattern (e.g., "*.pdf")'
    required: false
    default: 'false'
  release-name:
    description: 'Markdown string or path to document to be rendered by Stencila into release name (defaults to tag name)'
    required: false
  release-notes:
    description: 'Markdown string or path to document to be rendered by Stencila into release notes'
    required: false
  release-filenames:
    description: 'Markdown string or path to document for renaming uploaded files (defaults to no renaming)'
    required: false
  working-directory:
    description: 'Working directory to run Stencila commands'
    required: false
    default: '.'
  artifact-name:
    description: 'Name for the uploaded assets artifact (if assets is specified)'
    required: false
    default: 'assets'
  cache:
    description: 'Whether to cache the .stencila folder between runs'
    required: false
    default: 'true'
  install-tools:
    description: 'Run `stencila tools install` to ensure that workspace dependencies are available'
    required: false
    default: 'true'
  assume-answer:
    description: 'Assumed answer to any interactive prompts. Options: "yes", "no", or "cancel"'
    required: false
    default: 'yes'
  continue-on-error:
    description: 'Whether to continue running subsequent commands if one fails'
    required: false
    default: 'false'

outputs:
  version:
    description: 'The version of Stencila CLI that was installed'
  exit-code:
    description: 'Exit code from the Stencila command'

runs:
  using: 'node20'
  main: 'dist/index.js'