{"id":15286438,"url":"https://github.com/doktor-se/gha-checkout","last_synced_at":"2025-08-16T18:08:32.358Z","repository":{"id":38827569,"uuid":"434623195","full_name":"Doktor-se/gha-checkout","owner":"Doktor-se","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-16T05:59:05.000Z","size":21,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-08-10T18:37:21.303Z","etag":null,"topics":["action","actions","github-actions"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Doktor-se.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-12-03T14:23:39.000Z","updated_at":"2022-05-14T15:07:36.000Z","dependencies_parsed_at":"2023-02-10T01:15:18.779Z","dependency_job_id":null,"html_url":"https://github.com/Doktor-se/gha-checkout","commit_stats":{"total_commits":19,"total_committers":2,"mean_commits":9.5,"dds":0.368421052631579,"last_synced_commit":"1d21da9d714f2fa5ab0898e2b3647f3a934ab991"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Doktor-se/gha-checkout","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doktor-se%2Fgha-checkout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doktor-se%2Fgha-checkout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doktor-se%2Fgha-checkout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doktor-se%2Fgha-checkout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Doktor-se","download_url":"https://codeload.github.com/Doktor-se/gha-checkout/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Doktor-se%2Fgha-checkout/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270749194,"owners_count":24638673,"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","status":"online","status_checked_at":"2025-08-16T02:00:11.002Z","response_time":91,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","actions","github-actions"],"created_at":"2024-09-30T15:14:00.970Z","updated_at":"2025-08-16T18:08:32.327Z","avatar_url":"https://github.com/Doktor-se.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# gha-checkout\n\nIf you are working in a private organisation which uses submodules and/or private github actions its a hassle to checkout.\n\nThis is a reusable composite action to reduce copy pasta in your workflows.\n\nThis action will (depending on inputs) checkout the appropriate things. If you are using\n\n# Deprecation\nPrivate actions can now be used internally in private organisations.\n\nIf you don't need submodules update your checkout to just\n\n```yaml\n    - uses: actions/checkout@v3\n```\n\nIf you need submodules update your workflow to use the normal checkout action\n\n```yaml\n    - name: Checkout\n      uses: actions/checkout@v3\n      with:\n        token: ${{ secrets.\u003csecret name\u003e }}\n        submodules: true\n```\n\nActions that were previously used with a relative path can be updated to be used like any other action,\nthat means something like:\n\n```yaml\nuses: ./.github/composite-actions/some-private-action\n```\n\nwould become\n\n```yaml\nuses: \u003corg\u003e/composite-actions/some-private-action@main\n```\n\n\n# V3\n\nUses the same github token to checkout repo, actions, and submodules.\n`fetch-depth` can be set, defaults to 1, shallow checkout.\n\n```yaml\nname: CI\non: pull_request\n\njobs:\n  hello-world:\n    - uses: doktor-se/gha-checkout@v3\n      with:\n        token: ${{ secrets.GITHUB_PAT }}\n\n    - uses: ./.github/composite-actions/some-private-action\n\n    - run: echo \"hello world\"\n```\n\n# V2\n\nV2 does a shallow checkout of the submodule\n\nIf `submodules_key` is not set, submodules will be skipped.\nIf `actions_key` is not set, private actions will be skipped.\n\n\n```yaml\nname: CI\non: pull_request\n\njobs:\n  hello-world:\n    - uses: doktor-se/gha-checkout@v2\n      with:\n        submodules_key: ${{ secrets.SSH_SUBMODULES_KEY }}\n        actions_key: ${{ secrets.SSH_ACTIONS_KEY }}\n\n    - uses: ./.github/composite-actions/some-private-action\n\n    - run: echo \"hello world\"\n```\n# V1\n\nV1 does a full checkout of the submodule\n\nIf `submodules_key` is not set, submodules will be skipped.\nIf `actions_key` is not set, private actions will be skipped.\n\n\n```yaml\nname: CI\non: pull_request\n\njobs:\n  hello-world:\n    - uses: doktor-se/gha-checkout@v1\n      with:\n        submodules_key: ${{ secrets.SSH_SUBMODULES_KEY }}\n        actions_key: ${{ secrets.SSH_ACTIONS_KEY }}\n\n    - uses: ./.github/composite-actions/some-private-action\n\n    - run: echo \"hello world\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoktor-se%2Fgha-checkout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoktor-se%2Fgha-checkout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoktor-se%2Fgha-checkout/lists"}