Actions Required in the Plugin yaml
This release note is written in English and Portuguese, scroll to the end to access both languages.
Esta release note está escrita em Inglês e Português, role a página até o final para ter acesso às duas linguagens.
Content creators can now add required action in the plugin's yaml configuration.
What are Actions Required in the Plugin yaml and their benefits?
From this implementation, content creators have the possibility of having an action hook that allows them to pass parameters, determine when it will be executed and the version of the action. As well as having a new required action field in the plugin manifest for indexing.
For content creators, this new functionality allows you to work on some use cases, such as, for example, passing functions through plugins without having to change this function within each plugin whenever there is a change in them, this makes the use of resources more reusable.
How it works?
To have an action hook that allows parameters to be passed, the content creator can follow the following steps:
1 - First you need to add an action to the list of actions required by the plugin in the plugin.yaml file
requires:
actions:
- cli-studio/cli-stack@0.0.1/action-name
2 - Then you need to add the new run-action hook in the plugin.yaml file.
hooks:
- type: enforcement action
trigger: post-render
name: cli-studio/cli-stack@0.0.1/action-name
Appetizer:
user_name: user with {{ resource }}
Therefore, the plugin will perform this action when the plugin is applied, right after rendering the template files.
Supporting content
Os criadores de conteúdo agora podem adicionar action requerida na configuração do yaml do plugin.
O que são Actions Required in the Plugin yaml e seus benefícios?
A partir dessa implementação realizada, os criadores de conteúdo têm a possibilidade de ter um hook de action que permita passar parâmetros, determinar quando vai ser executado e a versão da action. Assim como, ter um novo campo de required action no manifesto do plugin para indexação.
Para os criadores de conteúdo, esta nova funcionalidade permite trabalhar em alguns casos de uso, como, por exemplo, passar funções através de plugins sem precisar alterar esta função dentro de cada plugin sempre que houver uma alteração nos mesmos, isso torna o uso de recursos mais reutilizáveis.
Como funciona?
Para ter um hook de action que permita passar parâmetros, o criador de conteúdo pode seguir os seguintes passos:
1 - Primeiro você precisa adicionar a action na lista de actions requeridas pelo plugin no arquivo plugin.yaml
requires:
actions:
- cli-studio/cli-stack@0.0.1/action-name
2 - Depois você precisa adicionar o novo hook do tipo run-action no arquivo plugin.yaml.
hooks:
- type: run-action
trigger: after-render
name: cli-studio/cli-stack@0.0.1/action-name
inputs:
user_name: User with {{ resource }}
Com isso o plugin irá executar essa action quando plugin for aplicado, logo após renderizar os arquivos de template.