Create My Awesome

Github Actions for automatically generating a personal awesome project to organize all your starred repositories.

简体中文

Usage

1. Create a new repository on Github
2. From this repository, create a new GitHub Actions workflow and copy the following YAML contents info the .yml file

name: 'build'
on:
  push:
    branches:
      - main
  schedule:
      # This expression means every day at UTC 00:00
      # See https://crontab.guru/examples.html for more examples
      - cron:  '0 0 * * *'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: luob/create-my-awesome@v1
      # Commit the change
      # See https://github.com/EndBug/add-and-commit
      - uses: EndBug/add-and-commit@v5
        with:
          message: 'Update README.md'
        env:
          GITHUB_TOKEN: ${{ github.token }}

• Pushing changes to Github with repositories's token(${{ github.token }}) will not create a new workflow run, so don't warry about creating recursive workflow runs.

Advanced Usage

  # ...
  - uses: luob/create-my-awesome@v1
    with:
      # You can use the data of any Github user, default to the owner of the repository
      username: zhang-san
      # customize the description, default to 'A collection of awesome things.'
      description: 'A cOllectiOn OF awesOme thiNgs.',
      # customize the target directory. Default to the root.
      targetDir: ./target/
  # ...

Contributing

  npm i
  npm run all

To run it locally, you can customize the variables in .env.example and save as .env. Then:

  npm run local

License

MIT