Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/imxnoobx/green-commits

Automatically keep GitHub commit status green.
https://github.com/imxnoobx/green-commits

autocommit commit github green green-status

Last synced: about 2 months ago
JSON representation

Automatically keep GitHub commit status green.

Awesome Lists containing this project

README

        

# ๐Ÿงถ Green Commits

[![ci](https://github.com/IMXNOOBX/green-commits/actions/workflows/ci.yml/badge.svg)](https://github.com/IMXNOOBX/green-commits/actions/workflows/ci.yml)

Automatically keep GitHub commit status green.

> Now the action will get a random quote from CW chapter titles defined in [`quotes.txt`](quotes.txt) and will run every moday & saturday

# ๐Ÿ“ฃ Whats New

> Added EMAIL, NAME secret, that way no one will be able to see ur email

## ๐ŸŒณ Simple Use

**โš ๏ธDo not fork, because the dynamics of the fork project will not make you green โš ๏ธ**

```diff
+ Use this template or the official one
1. Go to .github/workflows/cy.yml in your repository
2. Remove the # in line 7, 8
3. Go to https://github.com/yourGithubUsername/auto-green/settings/secrets/actions
3.1. Create a secret named EMAIL with your email
3.2. Create a scret named NAME with your github username
+ Enjoy the green Contribution Activity panel in your profile :D
```

## ๐Ÿ“˜ Developer Instructions

-Click the **Use this template** button in the upper right corner to copy this GitHub repository
- Modify [lines 7 and 8 of the ci.yml file](https://github.com/IMXNOOBX/green-commits/blob/master/.github/workflows/ci.yml#L7-L8) to remove the preceding ` #` sign
- ~~Modify [lines 19, 20 of the ci.yml file](https://github.com/IMXNOOBX/green-commits/blob/master/.github/workflows/ci.yml#L19-L20) to your own GitHub Account and Nickname~~
- (Optional) You can do this by modifying [line 8 of the ci.yml file](https://github.com/IMXNOOBX/green-commits/blob/master/.github/workflows/ci.yml#L8) Adjust frequency

The scheduled task syntax has 5 fields separated by spaces, each field representing a time unit.

```plain
โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ minutes (0 - 59)
โ”‚ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ Hours (0 - 23)
โ”‚ โ”‚ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ Day (1 - 31)
โ”‚ โ”‚ โ”‚ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ Month (1 - 12 or JAN-DEC)
โ”‚ โ”‚ โ”‚ โ”‚ โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€ Week of the week (0 - 6 or SUN-SAT)
โ”‚ โ”‚ โ”‚ โ”‚ โ”‚
โ”‚ โ”‚ โ”‚ โ”‚ โ”‚
โ”‚ โ”‚ โ”‚ โ”‚ โ”‚
* * * * *
```

**Note**: Due to the limitation of GitHub Actions, if set to `* * * * *` , the actual execution frequency is once every 5 minutes.

## License && Credits

- Credits: [**justjavac**](https://github.com/justjavac)
- License: [auto-green](https://github.com/justjavac/auto-green) is released under the MIT License. See the bundled [LICENSE](./LICENSE) file for details.