mingxin-yang / actionsflow-demo

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

🏁 Getting Started

Build an Actionsflow workflow is a four-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. Uncomment .github/workflows/actionsflow.yml schedule event

   on:
     schedule:
       - cron: "*/15 * * * *"

   Note: To prevent abuse, by default, the schedule is commented, please modify the schedule time according to your own needs, the default is once every 15 minutes. Learn more about schedule event, please see here

3. 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&count=3
   jobs:
     request:
       name: Make a HTTP Request
       runs-on: ubuntu-latest
       steps:
         - name: Make a HTTP Request
           uses: actionsflow/axios@v1
           with:
             url: https://hookb.in/VGPzxoWbdjtE22bwznzE
             method: POST
             body: |
               {
                 "link":"${{ on.rss.outputs.link }}", 
                 "title": "${{ on.rss.outputs.title }}",
                 "content":"<<<${{ on.rss.outputs.contentSnippet }}>>>"
               }

   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.

4. 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 Locally

You can run self-hosted Actionsflow manually or by docker:

Prerequisites

1. Install docker
2. Install act
3. Install dependencies by running npm install

Start

Start Actionsflow locally:

npm run start
# Then, the cron job and webhook server will start running
# The webhook endpoint will be ran at http://localhost:3000/webhook/

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

Learn more abount self-hosted Actionsflow here

🎓 Learn More

Full documentation for Actionsflow lives on the website.

• Workflow Syntax for Actionsflow - Learn more about the Actionsflow workflow file syntax
• Triggers List - Explore Actionsflow triggers
• Awesome Actionsflow Workflows - Explore Actionsflow workflows use case to get inspired
• Core Concepts - Learn more about how Actionsflow worked
• Creating Triggers for Actionsflow - Learn more about how to create your own trigger for Actionsflow
• FAQs - Actionsflow FAQs
• Upgrade Guide