Class: GhaWorkflowSecret

A secret under a reusable workflow’s on.workflow_call.secrets key, by name; its value is never recorded.

URI: gha:WorkflowSecret

 classDiagram
    class GhaWorkflowSecret
    click GhaWorkflowSecret href "../GhaWorkflowSecret/"
      GhaRequiredMixin <|-- GhaWorkflowSecret
        click GhaRequiredMixin href "../GhaRequiredMixin/"
      
      GhaWorkflowSecret : description
        
      GhaWorkflowSecret : required
        
      GhaWorkflowSecret : secret_id
        
      

Inheritance

• GhaWorkflowSecret [ GhaRequiredMixin]

Class Properties

Property	Value
Class URI	gha:WorkflowSecret

Slots

Name	Cardinality and Range	Description	Inheritance
description	0..1 String	What the input, output or secret is for, as the file describes it	direct
secret_id	1 GhaIdentifier	The key a caller passes the secret under	direct
required	0..1 Boolean	Whether a caller must supply a value	GhaRequiredMixin

Usages

used by	used in	type	used
GhaReusableWorkflow	secrets	range	GhaWorkflowSecret

See Also

• https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callsecrets

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/lmodel/github-actions

Mappings

Mapping Type	Mapped Value
self	gha:WorkflowSecret
native	gha:GhaWorkflowSecret

LinkML Source

Direct

name: GhaWorkflowSecret
description: A secret under a reusable workflow's `on.workflow_call.secrets` key,
  by name; its value is never recorded.
from_schema: https://w3id.org/lmodel/github-actions
see_also:
- https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callsecrets
mixins:
- GhaRequiredMixin
slots:
- description
attributes:
  secret_id:
    name: secret_id
    description: The key a caller passes the secret under.
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_workflow
    rank: 1000
    domain_of:
    - GhaWorkflowSecret
    range: gha_identifier
    required: true
class_uri: gha:WorkflowSecret

Induced

name: GhaWorkflowSecret
description: A secret under a reusable workflow's `on.workflow_call.secrets` key,
  by name; its value is never recorded.
from_schema: https://w3id.org/lmodel/github-actions
see_also:
- https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callsecrets
mixins:
- GhaRequiredMixin
attributes:
  secret_id:
    name: secret_id
    description: The key a caller passes the secret under.
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_workflow
    rank: 1000
    owner: GhaWorkflowSecret
    domain_of:
    - GhaWorkflowSecret
    range: gha_identifier
    required: true
  description:
    name: description
    description: What the input, output or secret is for, as the file describes it.
    comments:
    - It means what LOKF's description means and carries the same IRI, so lokf adapt
      folds it into LOKF's slot and a knowledge bundle reads one description key.
    from_schema: https://w3id.org/lmodel/github-actions
    rank: 1000
    slot_uri: schema:description
    owner: GhaWorkflowSecret
    domain_of:
    - GhaInput
    - GhaOutput
    - GhaWorkflowSecret
    range: string
  required:
    name: required
    description: Whether a caller must supply a value.
    comments:
    - 'An attribute rather than a slot: it carries LOKF''s IRI for required, and lokf
      adapt keeps an attribute''s name, where it would rename a slot that shares one
      with lokf.yaml.'
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_core
    rank: 1000
    slot_uri: schema:valueRequired
    owner: GhaWorkflowSecret
    domain_of:
    - GhaRequiredMixin
    range: boolean
class_uri: gha:WorkflowSecret