akifmt/github-update-recent-commits

github-update-recent-commits

Updates MD file with the recent commits. The configuration must be on the default branch

Live Preview

• 📄 Update README.md - 2023-07-24T23:58:37Z
• 📄 Update action.yaml - 2023-07-24T23:58:09Z
• 📄 Update action.yaml - 2023-07-24T23:55:15Z
• 📄 Update README.md - 2023-07-24T23:46:00Z
• 📄 Update README.md - 2023-07-24T23:45:34Z
• 📄 Update README.md - 2023-07-24T23:36:08Z
• 📄 Update action.yaml - 2023-07-24T23:35:49Z
• 📄 Update README.md - 2023-07-24T23:34:26Z
• 📄 Update action.yaml - 2023-07-24T23:34:03Z
• 📄 Update action.yaml - 2023-07-24T23:29:50Z

Instructions

• Add comment to .md file

### Latest Commits
<!-- Latest_Commits_Start -->
<!-- Latest_Commits_End -->

• Create a workflowfile .github/workflows/action.yaml

name: Update READMEs

on:
  workflow_dispatch:
  schedule:
  - cron: '*/15 * * * *'
  
jobs:
  action:
    runs-on: ubuntu-latest
    steps:
      - uses: akifmt/github-update-recent-commits@main
        with:
          GH_ACCESS_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }}
          MAX_COMMITS: 10
          COMMIT_SHOW_TYPE: LIST
          COMMIT_CUSTOM_LINE: "- :page_facing_up: [{{{commit_message}}}]({{{commit_link}}}) - {{{commit_date}}}"
          GET_COMMITS_USER_NAME: THIS_IS_USERNAME_FOR_GET_COMMITS
          GET_COMMITS_REPO_NAME: THIS_IS_REPONAME_FOR_GET_COMMITS
          GET_COMMITS_BRANCH_NAME: THIS_IS_BRANCHNAME_FOR_GET_COMMITS
          UPDATE_MDFILE_USER_NAME: THIS_IS_USERNAME_FOR_MDFILE
          UPDATE_MDFILE_REPO_NAME: THIS_IS_REPONAME_FOR_MDFILE
          UPDATE_MDFILE_BRANCH_NAME: THIS_IS_BRANCH_FOR_MDFILE
          UPDATE_MDFILE_NAME: THIS_IS_MDFILENAME

• This workflow works every 15 mins.
• COMMIT_SHOW_TYPE should be LIST, TABLE, CUSTOM
• When selecting CUSTOM, need to fill COMMIT_CUSTOM_LINE
• COMMIT_CUSTOM_LINE, supports MD, HTML. All Parameters; {{{commit_author_name}}} {{{commit_author_email}}} {{{commit_link}}} {{{commit_message}}} {{{commit_date}}}
  • Example;":page_facing_up: [{{{commit_message}}}]({{{commit_link}}}) - {{{commit_date}}}"
• Give your access token 'repo' permission.

Development Environment:

• Create .env file:

GH_ACCESS_TOKEN=THIS_IS_YOUR_TOKEN
MAX_COMMITS=10
COMMIT_SHOW_TYPE=LIST
COMMIT_CUSTOM_LINE: - :page_facing_up: [{{{commit_message}}}]({{{commit_link}}}) - {{{commit_date}}}
GET_COMMITS_USER_NAME=THIS_IS_USERNAME_FOR_GET_COMMITS
GET_COMMITS_REPO_NAME=THIS_IS_REPONAME_FOR_GET_COMMITS
GET_COMMITS_BRANCH_NAME=THIS_IS_BRANCHNAME_FOR_GET_COMMITS
UPDATE_MDFILE_USER_NAME=THIS_IS_USERNAME_FOR_MDFILE
UPDATE_MDFILE_REPO_NAME=THIS_IS_REPONAME_FOR_MDFILE
UPDATE_MDFILE_BRANCH_NAME=THIS_IS_BRANCH_FOR_MDFILE
UPDATE_MDFILE_NAME=THIS_IS_MDFILENAME

• Install npm packages:
  • npm install
• Run:
  • npm run start
• Prepare dist:
  • npm run build