{"id":21074800,"url":"https://github.com/dawsbot/degen-tips-readme-action","last_synced_at":"2025-03-14T03:26:32.836Z","repository":{"id":234297942,"uuid":"788603929","full_name":"dawsbot/degen-tips-readme-action","owner":"dawsbot","description":"GH Action to automatically add DEGEN tippers from farcaster to your readme","archived":false,"fork":false,"pushed_at":"2024-05-29T15:36:41.000Z","size":1133,"stargazers_count":2,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-20T22:41:25.763Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dawsbot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-18T18:28:27.000Z","updated_at":"2024-07-01T12:53:42.000Z","dependencies_parsed_at":"2024-05-29T18:14:38.526Z","dependency_job_id":null,"html_url":"https://github.com/dawsbot/degen-tips-readme-action","commit_stats":null,"previous_names":["dawsbot/degen-tips-readme-action"],"tags_count":6,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dawsbot%2Fdegen-tips-readme-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dawsbot%2Fdegen-tips-readme-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dawsbot%2Fdegen-tips-readme-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dawsbot%2Fdegen-tips-readme-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dawsbot","download_url":"https://codeload.github.com/dawsbot/degen-tips-readme-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243517460,"owners_count":20303632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T19:18:04.174Z","updated_at":"2025-03-14T03:26:32.815Z","avatar_url":"https://github.com/dawsbot.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DEGEN Tips Readme Action\n\n\u003e Add this to any repo you want to thank you DEGEN sponsors from Farcaster! It looks like this 👇\n\nThis repo made possible by all my Farcaster tippers 👇\n\n\u003c!-- replace-degen-sponsors --\u003e\n\n\u003ca href=\"https://warpcast.com/greg\"\u003e\u003cimg src=\"https://i.seadn.io/gae/YsASemS2qwPJK2yI9fmN8HX1-DeIDy9EQxX4KsRk9rkniwn9A7xUyMu_vKR75Oxrs8QAKfIjqdmf6Aw9A9fsehJHWSz2LiNpnV_TPQ?w=500\u0026auto=format\" width=\"60px\" alt=\"Greg\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/nbragg\"\u003e\u003cimg src=\"https://i.imgur.com/BacP8dn.jpg\" width=\"60px\" alt=\"Noah Bragg 🐟🥔\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/gami\"\u003e\u003cimg src=\"https://i.imgur.com/bBrLl7P.gif\" width=\"60px\" alt=\"呂丹冊工\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/polluterofminds\"\u003e\u003cimg src=\"https://i.seadn.io/gae/lhGgt7yK1JiBVYz_HBxcAmYLRtP03aw5xKX4FgmFT9Ai7kLD5egzlLvb0lkuRNl28shtjr07DC8IHzLUkTqlWUMndUzC9R5_MSxH3g?w=500\u0026auto=format\" width=\"60px\" alt=\"Justin Hunter\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/darrylyeo\"\u003e\u003cimg src=\"https://i.imgur.com/cso0QgT.png\" width=\"60px\" alt=\"Darryl Yeo 🛠️\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/alexgrover.eth\"\u003e\u003cimg src=\"https://i.imgur.com/PKRVjbX.jpg\" width=\"60px\" alt=\"alex\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/dos.eth\"\u003e\u003cimg src=\"https://i.imgur.com/dXBMJA1.gif\" width=\"60px\" alt=\"@developer 🎩👑\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/swishh.eth\"\u003e\u003cimg src=\"https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/5fdfb18d-39b9-4338-b174-a90b49ef3600/original\" width=\"60px\" alt=\"Swishh ↗🎩\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/corbin.eth\"\u003e\u003cimg src=\"https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/c3409587-b044-4743-2486-d5751894d900/original\" width=\"60px\" alt=\"Corbin Page 👑🎩\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/ds8\"\u003e\u003cimg src=\"https://i.imgur.com/pK5BjjD.jpg\" width=\"60px\" alt=\"dusan\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/nftlobby\"\u003e\u003cimg src=\"https://i.imgur.com/jmCPDK6.jpg\" width=\"60px\" alt=\"Howie NFTlobby/TAC🎩\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/wake\"\u003e\u003cimg src=\"https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/cb93be3f-659b-4709-6bed-88f6e5817b00/original\" width=\"60px\" alt=\"wake 🎩\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/alexk\"\u003e\u003cimg src=\"https://gmcafe.s3.us-east-2.amazonaws.com/keek/original/3020.png\" width=\"60px\" alt=\"alexk ⚡️🇮🇱🎩🍖\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/gilbster\"\u003e\u003cimg src=\"https://imagedelivery.net/BXluQx4ige9GuW0Ia56BHw/a82f67cc-3489-446c-0039-83097ea66d00/original\" width=\"60px\" alt=\"Alexander\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/tomuky.eth\"\u003e\u003cimg src=\"https://i.imgur.com/pxNCWDA.jpg\" width=\"60px\" alt=\"tomuky\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/gabo\"\u003e\u003cimg src=\"https://supercast.mypinata.cloud/ipfs/QmQifwMaWueQcg9oLu74EJoDHJ3PifCjUuKydF82rH3RWd?filename=Lucas-Verra-GIF_2.gif\" width=\"60px\" alt=\"Lucas | POAP Studio\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/tudorizer\"\u003e\u003cimg src=\"https://i.imgur.com/L3cPsrK.gif\" width=\"60px\" alt=\"Tudor 🟪 Engineer turned fCTO\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/vijay\"\u003e\u003cimg src=\"https://i.imgur.com/EetFrhB.jpg\" width=\"60px\" alt=\"Vijay\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/keller\"\u003e\u003cimg src=\"https://i.imgur.com/4g901hX.jpg\" width=\"60px\" alt=\"keller\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/jereld\"\u003e\u003cimg src=\"https://i.imgur.com/VbtLWtG.gif\" width=\"60px\" alt=\"jereld\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/prberg\"\u003e\u003cimg src=\"https://i.imgur.com/ccctjma.jpg\" width=\"60px\" alt=\"Paul Razvan Berg\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/h3lx.eth\"\u003e\u003cimg src=\"https://occb0ofnixhvqbrv.public.blob.vercel-storage.com/images/clut88yy104ho14apaq05u9jr.png\" width=\"60px\" alt=\"HΞLiX 🧙‍♂️🎩\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/alexastro\"\u003e\u003cimg src=\"https://i.imgur.com/dNpXbZg.png\" width=\"60px\" alt=\"Alex Astro\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/lolclark\"\u003e\u003cimg src=\"https://i.imgur.com/imQlhPL.gif\" width=\"60px\" alt=\"Lol Clark 🍪\" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/microchipgnu\"\u003e\u003cimg src=\"https://i.imgur.com/hvaOPrU.jpg\" width=\"60px\" alt=\"Micro \" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/slowking.eth\"\u003e\u003cimg src=\"https://i.imgur.com/Q30JRYM.gif\" width=\"60px\" alt=\"Amar.eth 🎩 ↑ \" /\u003e\u003c/a\u003e\n\u003ca href=\"https://warpcast.com/ngan300713\"\u003e\u003cimg src=\"https://i.imgur.com/2BL3qQX.jpg\" width=\"60px\" alt=\"Ngan 🔮 🎩 🍖 🧀\" /\u003e\u003c/a\u003e\n\n\u003c!-- replace-degen-sponsors --\u003e\n\n## Setup\n\n1. Place this in your readme the images of your tippers will be injected between automatically:\n\n```md\n\u003c!-- replace-degen-sponsors --\u003e\n\u003c!-- replace-degen-sponsors --\u003e\n```\n\n1. Add or edit your github action to include these four lines:\n\n```yaml\n- uses: dawsbot/degen-tips-readme-action@v1\n  with:\n    FARCASTER_USERNAME: ${{ secrets.FARCASTER_USERNAME }}\n    DUNE_API_KEY: ${{ secrets.DUNE_API_KEY }}\n```\n\n1.  Add those three variables to your [GitHub actions secrets](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)\n\n1.  Run the action! ✨\n\n#### Required Choices\n\n1. The following options must be configured.\n\n| Key                  | Value Information                                                | Type   | Required |\n| -------------------- | ---------------------------------------------------------------- | ------ | -------- |\n| `FARCASTER_USERNAME` | The farcaster username for which you want to pull tips for       | `with` | **Yes**  |\n| `DUNE_API_KEY`       | Used to pull the tips you've received alongside the size of tips | `with` | **Yes**  |\n\n#### Optional Choices\n\n| Key    | Value Information                                                                                                                                       | Type   | Required |\n| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- |\n| `FILE` | This should point to the file that you're generating, for example `README.md` or `path/to/CREDITS.md`. Defaults to `README.md` if no value is provided. | `with` | **Yes**  |\n\n## Contributing\n\n1. :hammer_and_wrench: Install the dependencies\n\n   ```bash\n   npm install\n   ```\n\n1. :building_construction: Package the TypeScript for distribution\n\n   ```bash\n   npm run build\n   ```\n\n1. :white_check_mark: Run the tests\n\n   ```bash\n   $ npm test\n\n   PASS  ./index.test.js\n     ✓ throws invalid number (3ms)\n     ✓ wait 500 ms (504ms)\n     ✓ test runs (95ms)\n\n   ...\n   ```\n\n## Update the Action Metadata\n\nThe [`action.yml`](action.yml) file defines metadata about your action, such as\ninput(s) and output(s). For details about this file, see\n[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions).\n\nWhen you copy this repository, update `action.yml` with the name, description,\ninputs, and outputs for your action.\n\n## Update the Action Code\n\nThe [`src/`](./src/) directory is the heart of your action! This contains the\nsource code that will be run when your action is invoked. You can replace the\ncontents of this directory with your own code.\n\nThere are a few things to keep in mind when writing your action code:\n\n- Most GitHub Actions toolkit and CI/CD operations are processed asynchronously.\n  In `main.ts`, you will see that the action is run in an `async` function.\n\n  ```javascript\n  import * as core from '@actions/core';\n  //...\n\n  async function run() {\n    try {\n      //...\n    } catch (error) {\n      core.setFailed(error.message);\n    }\n  }\n  ```\n\n  For more information about the GitHub Actions toolkit, see the\n  [documentation](https://github.com/actions/toolkit/blob/master/README.md).\n\nSo, what are you waiting for? Go ahead and start customizing your action!\n\n1. Create a new branch\n\n   ```bash\n   git checkout -b releases/v1\n   ```\n\n1. Replace the contents of `src/` with your action code\n1. Format, test, and build the action\n\n   ```bash\n   npm run all\n   ```\n\n\u003e This step is important! It will run [`ncc`](https://github.com/vercel/ncc)\n\u003e to build the final JavaScript action code with all dependencies included.\n\u003e If you do not run this step, your action will not work correctly when it is\n\u003e used in a workflow. This step also includes the `--license` option for\n\u003e `ncc`, which will create a license file for all of the production node\n\u003e modules used in your project.\n\n1. Commit your changes\n\n   ```bash\n   git add .\n   git commit -m \"My first action is ready!\"\n   ```\n\n1. Push them to your repository\n\n   ```bash\n   git push -u origin releases/v1\n   ```\n\n1. Create a pull request and get feedback on your action\n1. Merge the pull request into the `main` branch\n\nYour action is now published! :rocket:\n\nFor information about versioning your action, see\n[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)\nin the GitHub Actions toolkit.\n\n## Validate the Action\n\nYou can now validate the action by referencing it in a workflow file. For\nexample, [`ci.yml`](./.github/workflows/ci.yml) demonstrates how to reference an\naction in the same repository.\n\n```yaml\nsteps:\n  - name: Checkout\n    id: checkout\n    uses: actions/checkout@v4\n\n  - name: Test Local Action\n    id: test-action\n    uses: ./\n    with:\n      milliseconds: 1000\n\n  - name: Print Output\n    id: output\n    run: echo \"${{ steps.test-action.outputs.time }}\"\n```\n\nFor example workflow runs, check out the\n[Actions tab](https://github.com/actions/typescript-action/actions)! :rocket:\n\n## Usage\n\nAfter testing, you can create version tag(s) that developers can use to\nreference different stable versions of your action. For more information, see\n[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)\nin the GitHub Actions toolkit.\n\nTo include the action in a workflow in another repository, you can use the\n`uses` syntax with the `@` symbol to reference a specific branch, tag, or commit\nhash.\n\n```yaml\nsteps:\n  - name: Checkout\n    id: checkout\n    uses: actions/checkout@v4\n\n  - name: Test Local Action\n    id: test-action\n    uses: actions/typescript-action@v1 # Commit with the `v1` tag\n    with:\n      milliseconds: 1000\n\n  - name: Print Output\n    id: output\n    run: echo \"${{ steps.test-action.outputs.time }}\"\n```\n\n## Publishing a New Release\n\nThis project includes a helper script, [`script/release`](./script/release)\ndesigned to streamline the process of tagging and pushing new releases for\nGitHub Actions.\n\nGitHub Actions allows users to select a specific version of the action to use,\nbased on release tags. This script simplifies this process by performing the\nfollowing steps:\n\n1. **Retrieving the latest release tag:** The script starts by fetching the most\n   recent release tag by looking at the local data available in your repository.\n1. **Prompting for a new release tag:** The user is then prompted to enter a new\n   release tag. To assist with this, the script displays the latest release tag\n   and provides a regular expression to validate the format of the new tag.\n1. **Tagging the new release:** Once a valid new tag is entered, the script tags\n   the new release.\n1. **Pushing the new tag to the remote:** Finally, the script pushes the new tag\n   to the remote repository. From here, you will need to create a new release in\n   GitHub and users can easily reference the new tag in their workflows.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdawsbot%2Fdegen-tips-readme-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdawsbot%2Fdegen-tips-readme-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdawsbot%2Fdegen-tips-readme-action/lists"}