https://github.com/luooooob/create-my-awesome

Github Actions for automatically generating the personal awesome list from all of the repositories you starred.
https://github.com/luooooob/create-my-awesome

List: create-my-awesome

Last synced: about 1 month ago
JSON representation

Github Actions for automatically generating the personal awesome list from all of the repositories you starred.

• Host: GitHub
• URL: https://github.com/luooooob/create-my-awesome
• Owner: luooooob
• License: mit
• Created: 2020-12-08T11:37:08.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T20:04:23.000Z (almost 2 years ago)
• Last Synced: 2024-10-29T15:43:48.675Z (about 1 month ago)
• Language: TypeScript
• Size: 1.15 MB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - luooooob/create-my-awesome - Github Actions for automatically generating the personal awesome list from all of the repositories you starred. (TypeScript)
• project-awesome - luooooob/create-my-awesome - Github Actions for automatically generating the personal awesome list from all of the repositories you starred. (TypeScript)

README

        
# Create My Awesome

![GitHub release](https://img.shields.io/github/v/release/luob/create-my-awesome)

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/luob/create-my-awesome/build-test)

![GitHub top language](https://img.shields.io/github/languages/top/luob/create-my-awesome)

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

[简体中文](./README.zh-Hans.md)

## Usage

1. [Create a new repository on Github](https://github.com/new)

2. From this repository, [create a new GitHub Actions workflow](https://docs.github.com/en/free-pro-team@latest/actions/quickstart) and copy the following YAML contents info the `.yml` file

```yaml

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

```yaml

  # ...

  - 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

```sh

  npm i

  npm run all

```

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

```sh

  npm run local

```

## License

[MIT](LICENSE)