{"id":13623764,"url":"https://github.com/actions-js/profile-readme","last_synced_at":"2025-04-15T20:32:12.322Z","repository":{"id":54480909,"uuid":"281050564","full_name":"actions-js/profile-readme","owner":"actions-js","description":"🗣 Display profile activity and other cool widgets in your profile README.md","archived":false,"fork":false,"pushed_at":"2023-07-09T08:20:15.000Z","size":443,"stargazers_count":72,"open_issues_count":5,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-26T15:01:48.091Z","etag":null,"topics":["action","profile","profile-readme","readme"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/profile-readme","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/actions-js.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}},"created_at":"2020-07-20T07:49:19.000Z","updated_at":"2024-02-23T12:31:39.000Z","dependencies_parsed_at":"2024-01-14T07:58:59.133Z","dependency_job_id":"5bf3a0d1-b2bb-4d8a-bca4-bb42260c164a","html_url":"https://github.com/actions-js/profile-readme","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions-js%2Fprofile-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions-js%2Fprofile-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions-js%2Fprofile-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/actions-js%2Fprofile-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/actions-js","download_url":"https://codeload.github.com/actions-js/profile-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249148059,"owners_count":21220469,"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":["action","profile","profile-readme","readme"],"created_at":"2024-08-01T21:01:35.379Z","updated_at":"2025-04-15T20:32:12.023Z","avatar_url":"https://github.com/actions-js.png","language":"TypeScript","funding_links":[],"categories":["GitHub Actions for Readmes","TypeScript","🛠️ Widgets 👇"],"sub_categories":[],"readme":"# GitHub Action for Profile Readme\n\nThe GitHub Actions for adding simple widgets to your profile readme.\n\n## Usage\n\n### Example Workflow file\n\nAn example workflow to authenticate with GitHub Platform:\n\n```yaml\njobs:\n  publish:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@master\n        with:\n          persist-credentials: false\n          fetch-depth: 0\n      - name: Create README.md\n        uses: actions-js/profile-readme@master\n        with:\n          username: \u003cyour username\u003e\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n      - name: Commit \u0026 Push changes\n        uses: actions-js/push@master\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n### Example TEMPLATE.md file\n\n```markdown\n## my cool name\n\n### 🗣 My activity:\n\n\u003c!--GITHUB_ACTIVITY:{\"rows\": 5}--\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\n  Last refresh: \n  \u003cb\u003e\u003c!--TIMESTAMP--\u003e\u003c/b\u003e\n\u003c/p\u003e\n```\n\n### Widgets\n\nAll widgets are identified by and HTML commend containing only a name and\noptionally a JSON configuration, appended after the name, separated by a `:`.\nJSON configuration are always optional.\n\n#### GitHub Activity\n\nDisplay your most recent GitHub activity\n\n```markdown\n\u003c!--GITHUB_ACTIVITY:{\"rows\": 5, \"raw\": true}--\u003e\n```\n\ndisplays as:\n\n```\n💪 Opened PR #43 in webview/webview_deno\n❗️ Closed issue #32 in denosaurs/denon\n🗣 Commented on #6 in nestdotland/hatcher\n❗️ Closed issue #22 in nestdotland/eggs\n🗣 Commented on #15 in nestdotland/eggs\n```\n\n##### Configuration\n\n| option  | value    | default | description                                                                                        |\n| ------- | -------- | ------- | -------------------------------------------------------------------------------------------------- |\n| rows    | string   | `10`    | Maximum number of rows to generate.                                                                |\n| raw     | boolean  | `false` | Strip markdown formatting.                                                                         |\n| include | string[] | all     | Select which of the [supported events](#supported-events) you want to **include** in the showcase. |\n| exclude | string[] | `[]`    | Select which of the [supported events](#supported-events) you want to **exclude** in the showcase. |\n\n##### Supported events\n\n```typescript\n\"IssueCommentEvent\",\n  \"IssuesEvent\",\n  \"PullRequestEvent\",\n  \"ForkEvent\",\n  \"ReleaseEvent\",\n  \"PushEvent\";\n```\n\n#### GitHub Repos\n\nDisplay your most recent GitHub activity\n\n```markdown\n\u003c!--GITHUB_REPOS:{\"rows\": 4, \"raw\": true}--\u003e\n```\n\ndisplays as:\n\n```\n📦 webview/webview_deno: ⭐️ 439\n📦 denosaurs/denon: ⭐️ 415\n📦 nestdotland/eggs: ⭐️ 8\n📦 nestdotland/hatcher: ⭐️ 2\n```\n\n##### Configuration\n\n| option | value   | default   | description                                                                |\n| ------ | ------- | --------- | -------------------------------------------------------------------------- |\n| rows   | string  | `10`      | Maximum number of rows to generate.                                        |\n| sort   | string  | `\"stars\"` | Sort repositories by \"stars\", \"created\", \"updated\", \"pushed\", \"full_name\". |\n| raw    | boolean | `false`   | Strip markdown formatting.                                                 |\n\n#### Current Timestamp\n\nDisplay your most recent GitHub activity\n\n```markdown\n\u003c!--TIMESTAMP:{\"format\": \"dddd, MMMM Do YYYY, h:mm:ss\"}--\u003e\n```\n\ndisplays as:\n\n```\nTuesday, July 21st 2020, 8:52:54 am UTC\n```\n\n##### Configuration\n\n| option | value   | default  | description                                                               |\n| ------ | ------- | -------- | ------------------------------------------------------------------------- |\n| format | string  | ISO 8601 | moment [format](https://momentjs.com/docs/#/displaying/).                 |\n| tz     | boolean | UTC      | moment [timezone](https://momentjs.com/timezone/docs/#/using-timezones/). |\n\n#### Feed\n\nDisplay items from web feeds such as rss or atom.\n\n```markdown\n\u003c!--FEED:{\"rows\": 5, \"select\": \"hackernews show\", shuffle: true, \"title\": true  }--\u003e\n\n\u003c!--FEED:{\"rows\": 5, \"select\": [\"hackernews ask\", \"hackernews show\"], \"raw\": true, \"title\": true }--\u003e\n```\n\ndisplays as:\n\n### 📰 Hackernews Show\n\n\u003e This is generated from feed provided [here](https://hnrss.org/show). Add it to your rss reader!\n\n---\n\n| Index | Posts                                                                                                        | Domain                                                 |\n| ----- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ |\n| 1     | [Show HN: Johariapp – For individuals to track their performance on Johari Window](https://johariapp.com/)   | [johariapp.com](https://johariapp.com)                 |\n| 2     | [Show HN: Create and Monetize your Zoom Events in under 2 Minutes](http://ditto.video/)                      | [ditto.video](http://ditto.video)                      |\n| 3     | [Show HN: Compare various PDF-to-text libraries in a few clicks](https://www.apibatchtest.com/)              | [www.apibatchtest.com](https://www.apibatchtest.com)   |\n| 4     | [Show HN: UDT Courseware – Train people how to label a dataset](https://universaldatatool.com/courses)       | [universaldatatool.com](https://universaldatatool.com) |\n| 5     | [Show HN: An OpenStreetMap Gutenberg Block for WordPress](https://wordpress.org/plugins/ootb-openstreetmap/) | [wordpress.org](https://wordpress.org)                 |\n\n### 📋 Hackernews Ask\n\n\u003e This is generated from feed provided [here](https://hnrss.org/show). Add it to your rss reader!\n\n---\n\n1.  [Show HN: Johariapp – For individuals to track their performance on Johari Window](https://johariapp.com/) ([johariapp.com](https://johariapp.com))\n\n2.  [Show HN: Create and Monetize your Zoom Events in under 2 Minutes](http://ditto.video/) ([ditto.video](http://ditto.video))\n\n3.  [Show HN: Compare various PDF-to-text libraries in a few clicks](https://www.apibatchtest.com/) ([www.apibatchtest.com](https://www.apibatchtest.com))\n4.  [Show HN: UDT Courseware – Train people how to label a dataset](https://universaldatatool.com/courses) ([universaldatatool.com](https://universaldatatool.com))\n\n5.  [Show HN: An OpenStreetMap Gutenberg Block for WordPress](https://wordpress.org/plugins/ootb-openstreetmap/) ([wordpress.org](https://wordpress.org))\n\n##### Configuration\n\n| option  | value    | default | description                                                  |\n| ------- | -------- | ------- | ------------------------------------------------------------ |\n| rows    | number   | `5`     | Number of items to display                                   |\n| raw     | boolean  | `false` | Strip table markdown                                         |\n| shuffle | boolean  | `false` | Shuffle the items from the feed                              |\n| title   | boolean  | `false` | Controls whether to add a title automatically from the feed. |\n| select  | string[] | `all[]` | Select specific feeds to display.                            |\n\nHere's what `FEEDS.json` looks like.\n\n```json\n{\n  \"hackernews top\": \"https://hnrss.org/frontpage\",\n  \"hackernews show\": \"https://hnrss.org/show\",\n  \"hackernews ask\": \"https://hnrss.org/show\"\n}\n```\n\n### Inputs\n\n| name         | value  | default         | description                                                               |\n| ------------ | ------ | --------------- | ------------------------------------------------------------------------- |\n| github_token | string |                 | Token for the repo. Can be passed in using `${{ secrets.GITHUB_TOKEN }}`. |\n| username     | string |                 | Github profile username.                                                  |\n| feed         | string | \"FEEDS.json\"    | FEEDS.json file                                                           |\n| template     | string | './TEMPLATE.md' | TEMPLATE.md file path.                                                    |\n| readme       | string | './README.md'   | README.md output file path.                                               |\n|              |\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factions-js%2Fprofile-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Factions-js%2Fprofile-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Factions-js%2Fprofile-readme/lists"}