Puts a random programming quote to your README! It is a fun little project built by myself to satisfy the desire to have a randomly selected programming quote being put into my profile README. Feel free to use it for your own profile readmes!

Put this in your README (the ... stand for preceding and subsequent readme content, please ignore that)

... <!--PROGRAMMING-QUOTE-BOT:start--> <!--PROGRAMMING-QUOTE-BOT:end--> ...

Do not place any content between these 2 comments as they WILL be removed by the GitHub action

After adding these comments, make a new yml file in .github/workflows under your root directory. It can have any name that

For the sake of this example, let's just name it random_programming_quote_action.yml

Next, please put the following code in that file.

name: Random Programming Quote on: schedule: - cron: '*/30 * * * *' workflow_dispatch: jobs: putRandomQuote: runs-on: ubuntu-latest name: Put a random random programming quote in README steps: - uses: actions/checkout@v4 - name: Setup Node Environment uses: actions/setup-node@v4 with: node-version: '14' - name: Update the README uses: SpiderMath/Random-Quote-Action@main env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: QUOTE_FONT_SIZE: 6 COMMIT_MESSAGE: 'Updated the README with a new Programming Quote 💻 ' ITALICS: true BLOCKQUOTES: true

ℹ Also, you can change the cron parameter to change the duration till which you want to update the readme, this updates the readme every 30 minutes

Feel free to add some feature requests, new quotes or suggest some bug-fixes! I may not be available instantly, as I'm a student, but I'll definitely look into it after I return from any hiatuses!

The project is basically a simple GitHub Action, which uses the actions/checkout and actions/setup-node to setup the node environment. The list of quotes is present in the Data/Quotes.json, and our source code is present at Source/Actions.js.

After we've finished our script however, we need to compile it into a single file. We do so and save it in the dist folder using the following command, facilated by the ncc package.

npx ncc build ./Source/Actions.js -o Dist

To avoid having to keep rewriting this command again and again, I've added the build script to the package.json, and you can invoke the same via the following:

npm run build

As of v1.2.0, we are using @vercel/ncc instead of @zeit/ncc due to the deprecation of the latter.

And that's pretty much it! Just run the action, and you'll see a random quote being shipped in every 30 minutes or the timeout you've set! Hope it proved useful, enjoy! 😁