Skip to content

actionsflow/workflow-for-actionsflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a workflow repository powered by Actionsflow, generated from actionsflow/actionsflow-workflow-default

🏁 Getting Started

Build an Actionsflow workflow is a three-step process:

  1. Create a public Github repository by this link.

    A typical Actionsflow repository structure looks like this:

    ├── .github
    │   └── workflows
    │       └── actionsflow.yml
    ├── .gitignore
    ├── README.md
    └── workflows
    │   └── rss.yml
    │   └── webhook.yml
    └── package.json
  2. Define your workflow file at workflows directory

    A typical workflow file rss.yml looks like this:

    on:
      rss:
        url: https://hnrss.org/newest?points=300
    jobs:
      ifttt:
        name: Make a Request to IFTTT
        runs-on: ubuntu-latest
        steps:
          - uses: actionsflow/ifttt-webhook-action@v1
            with:
              event: notice
              key: ${{ secrets.IFTTT_KEY }}
              value1: ${{on.rss.outputs.title}}
              value2: ${{on.rss.outputs.contentSnippet}}
              value3: ${{on.rss.outputs.link}}

    For more information about the Actionsflow workflow file, see the Actionsflow workflow reference.

    You can explore Triggers List or Awesome Actionsflow Workflows to get more inspired.

  3. Commit and push your updates to Github

Then, Actionsflow will run your workflows as you defined, you can view logs at your repository actions tab at Github

For more information, see Full documentation

Run manually

The power of Actionsflow comes from the Github workflow file .github/workflows/actionsflow.yml, usually, Actionsflow runs with a per 5 minutes' scheduled event, but you can also run it manually by workflow_dispatch event. Click Actions tab of your repository, and click Run workflow at Actionsflow workflow.

For more information, see Manually running a workflow

Run Locally

You can run Actionsflow locally for testing your workflow files.

Install

npm install

Build

npm run build
# Then, the standard workflow files will be built at ./dist/workflows

Clean

Actionsflow build will use cache for deduplicating the data, if you want to test your workflow with the same data, you may need to clean the cache by the following command:

# Clean the cache and dist folder.
npm run clean

If you want to run workflows built by Actionsflow locally, you should use npm run act, for more information, see act

🎓 Learn More

Full documentation for Actionsflow lives on the website.

Releases

No releases published

Packages

No packages published