Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 2.33 KB

README.md

File metadata and controls

61 lines (36 loc) · 2.33 KB

@ubiquity-os/personal-agent

The Personal Agent is a UbiquityOS plugin designed to run actions in user's Github account. It is forked, configured, and hosted by a Github user. Any issue comment beginning with /@username is forwarded to this plugin for processing. Find below a list features offered by the plugin:

  • /@username say hello The plugin should respond with a Hello.

More features coming soon...

Communication between UbiquityOS and the Personal Agent plugin is handled by Personal Agent Bridge.

How to set up?

  • Make sure the Personal Agent Bridge is also configured. You can read its documentation.

  • Fork this repository with exactly the same name personal-agent under your personal or your organization account.

  • Generate a Github fine-grained Personal Access Token PAT with access to this repository only. Required repository permissions:

    • Actions: Read & write
    • Metadata: Read-only

  • Encrypt your fine-grained PAT with UbiquityOS's X25519_PUBLIC_KEY using keygen.ubq.fi.

  • Add the encrypted fine-grained PAT in your fork's .github/personal-agent.config.yml file.

  • Create a Personal Access Token (classic) with following permissions

    • public_repo

  • Add the Personal Access Token (classic) as a repository secret of Personal Agent with name: PERSONAL_AGENT_PAT_CLASSIC

Usage

Go to any repository issue where UbiquityOS is installed. Comment as below:

/@username say hello`

Replace username with the username where the plugin has been forked. You should get a reply from the personal-agent of the user.

Troubleshooting

In most cases you should also receive an error message if there is a problem. If you do not get any response or want to look into the details of an error, check Personal Agent Bridge and Personal Agent fork's actions logs.

Get started with development

  • Install dependencies
yarn install
  • Run tests
yarn test

More information

The initial discussion about the development of this plugin can be found here.