{"id":24033760,"url":"https://github.com/daanv2/typescript-action-create-indexes","last_synced_at":"2026-01-28T23:32:06.889Z","repository":{"id":40558938,"uuid":"347423017","full_name":"DaanV2/Typescript-Action-Create-Indexes","owner":"DaanV2","description":"The github action that creates include code files for your project, the changes still need to be submitted afterwards.","archived":false,"fork":false,"pushed_at":"2024-11-04T12:43:31.000Z","size":372,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-04T13:38:17.450Z","etag":null,"topics":["actions","code","code-generation","github-action","github-actions","include","typescript","workflows"],"latest_commit_sha":null,"homepage":"","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/DaanV2.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}},"created_at":"2021-03-13T16:38:37.000Z","updated_at":"2024-11-04T12:43:35.000Z","dependencies_parsed_at":"2023-01-11T17:21:54.824Z","dependency_job_id":"6c40b9a8-8536-48cf-96e4-03c9214f5afc","html_url":"https://github.com/DaanV2/Typescript-Action-Create-Indexes","commit_stats":{"total_commits":81,"total_committers":2,"mean_commits":40.5,"dds":0.345679012345679,"last_synced_commit":"127e937c9640f3f5fb26d36709ea3e0a503577f5"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaanV2%2FTypescript-Action-Create-Indexes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaanV2%2FTypescript-Action-Create-Indexes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaanV2%2FTypescript-Action-Create-Indexes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaanV2%2FTypescript-Action-Create-Indexes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DaanV2","download_url":"https://codeload.github.com/DaanV2/Typescript-Action-Create-Indexes/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233085641,"owners_count":18622801,"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":["actions","code","code-generation","github-action","github-actions","include","typescript","workflows"],"created_at":"2025-01-08T18:54:41.443Z","updated_at":"2026-01-28T23:32:06.882Z","avatar_url":"https://github.com/DaanV2.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typescript-Action-Create-Indexes\n\n[![tagged-release](https://github.com/DaanV2/Typescript-Action-Create-Indexes/actions/workflows/tagged-release.yml/badge.svg)](https://github.com/DaanV2/Typescript-Action-Create-Indexes/actions/workflows/tagged-release.yml)\n[![unit-test](https://github.com/DaanV2/Typescript-Action-Create-Indexes/actions/workflows/npm-test.yml/badge.svg)](https://github.com/DaanV2/Typescript-Action-Create-Indexes/actions/workflows/npm-test.yml)\n\n- [Typescript-Action-Create-Indexes](#typescript-action-create-indexes)\n  - [Inputs](#inputs)\n  - [Examples](#examples)\n  - [Example usage](#example-usage)\n\nThe github action that creates indexes code files for your project, the changes still need to be submitted afterwards.\n\nIts creates a list of each typescript file in the folder and for each sub folder that has an `index.ts`.\n\n## Inputs\n\n**folder**:  \nThe folder path to start at, use `${{github.workspace}}/source`\n\n**excludes**:  \nThe multi string glob patterns that can exclude files from being listed\n\n**export_sub_index**:  \ndefaults to true\nWhenever or not a index.ts file should be specially exported:\nsuch as:\n\n```ts\nexport * as Foo from 'Foo/index';\n```\n\n\n## Examples\n\n![example](https://raw.githubusercontent.com/DaanV2/Typescript-Action-Create-Indexes/main/assets/example.PNG)\n\n## Example usage\n\n```yml\n# This is a basic workflow to help you get started with Actions\n\nname: Creating typescript indexes\n\n# Controls when the action will run. \non:\n  # Triggers the workflow on push or pull request events but only for the master branch\n  push:\n    branches: [ main ]\n  pull_request:\n    branches: [ main ]\n\n  # Allows you to run this workflow manually from the Actions tab\n  workflow_dispatch:\n\n# A workflow run is made up of one or more jobs that can run sequentially or in parallel\njobs:\n  # This workflow contains a single job called \"build\"\n  build:\n    # The type of runner that the job will run on\n    runs-on: ubuntu-latest\n\n    # Steps represent a sequence of tasks that will be executed as part of the job\n    steps:\n      - uses: actions/checkout@v2.3.4\n\n      # Runs a single command using the runners shell\n      - uses: DaanV2/Typescript-Action-Create-Indexes@latest\n        with: \n          folder: ${{github.workspace}}/server/src\n          export_sub_index: false\n          excludes: \"*.test.ts\"\n\n      - uses: DaanV2/Typescript-Action-Create-Indexes@latest\n        with: \n          folder: ${{github.workspace}}/client/src\n          excludes: |\n            \"*.test.ts\"\n            \"index.ts\"\n\n      - name: Commit changes\n        continue-on-error: true\n        run: |\n          cd ${{github.workspace}}\n          git config --global user.email \"Bot@DaanV2.com\"\n          git config --global user.name \"Bot\"\n          git add .\n          git commit -m \"auto: Generated typescript indexes\"\n          git push\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaanv2%2Ftypescript-action-create-indexes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaanv2%2Ftypescript-action-create-indexes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaanv2%2Ftypescript-action-create-indexes/lists"}