Skip to content

anglinb/foam-capture-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

typescript-action status

Capture knowledge into foam knowledge base!

Foam is knowledge graph suit that allows you to collect, visualize and interrelate data. This action allows you to quickly capture your thoughts to an inbox to revisit them later.

Usage

1. Setup Action

name: Manually triggered workflow
on:
  workflow_dispatch:
    inputs:
      data:
        description: 'What information to put in the knowledge base.'
        required: true
        
jobs:
  store_data:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - uses: anglinb/foam-capture-action@main
      with: 
        capture: ${{ github.event.inputs.data }}
    - run: |
        git config --local user.email "example@gmail.com"
        git config --local user.name "Your name"
        git commit -m "Captured from workflow trigger" -a
        git push -u origin master

2. Invoke Action w/ a workflow_dispatch event

Be sure to replace GITHUB_TOKEN with a Personal Access Token with the repo scope.

curl \
  -H "Accept: application/vnd.github.v3+json" \
  -H "Authorization: Bearer <GITHUB_TOKEN>" \
  -X POST  --data '{"ref": "master", "inputs": { "data": "This will end up in your knowledge base!"}}' jhttps://api.github.com/repos/<owner>/<repository>/actions/workflows/<workflow-id>/dispatches

This command won't return any information but you should see the workflow kick off!

Note: You can find your workflow-id by listing workflow with this command. The id you're looking for is in key "id" and will be an integer.

curl \
  -H "Accept: application/vnd.github.v3+json" \
  -H "Authorization: Bearer <GITHUB_TOKEN>" \
    https://api.github.com/repos/<owner>/<repository>/actions/workflows

3. (Optional) Create an iOS Shortcut

I have created a shortcut trigger the GitHub Action. Copy the shortcut and be sure to fill in the same values you did in the curl example.

Once this shortcut is working, you should be able to go from share sheet in iOS to knowledge base! ✨

About

A GitHub Action to expose foam-capture via the workflow dispatch event

Resources

License

Stars

Watchers

Forks

Packages

No packages published