From 2272602ba72f30de76c29def6d4a2f95f8ecec39 Mon Sep 17 00:00:00 2001 From: alberto96a11 Date: Mon, 15 Sep 2025 03:11:01 -0600 Subject: [PATCH 1/5] Create deno.yml --- .github/workflows/deno.yml | 42 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/workflows/deno.yml diff --git a/.github/workflows/deno.yml b/.github/workflows/deno.yml new file mode 100644 index 0000000..782af35 --- /dev/null +++ b/.github/workflows/deno.yml @@ -0,0 +1,42 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +# This workflow will install Deno then run `deno lint` and `deno test`. +# For more information see: https://github.com/denoland/setup-deno + +name: Deno + +on: + push: + branches: ["main"] + pull_request: + branches: ["main"] + +permissions: + contents: read + +jobs: + test: + runs-on: ubuntu-latest + + steps: + - name: Setup repo + uses: actions/checkout@v4 + + - name: Setup Deno + # uses: denoland/setup-deno@v1 + uses: denoland/setup-deno@61fe2df320078202e33d7d5ad347e7dcfa0e8f31 # v1.1.2 + with: + deno-version: v1.x + + # Uncomment this step to verify the use of 'deno fmt' on each commit. + # - name: Verify formatting + # run: deno fmt --check + + - name: Run linter + run: deno lint + + - name: Run tests + run: deno test -A From 4b4c83ea7a8eeddf483c2216e8acac84ec78910b Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 19 Sep 2025 05:40:26 +0000 Subject: [PATCH 2/5] Initial plan From 93a0983ecb26340b6cdac15a8f98cbd36f3425df Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 19 Sep 2025 05:44:53 +0000 Subject: [PATCH 3/5] Add comprehensive .github/copilot-instructions.md for AI coding agents Co-authored-by: alberto96a11 <198290213+alberto96a11@users.noreply.github.com> --- .github/copilot-instructions.md | 121 ++++++++++++++++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..0430b07 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,121 @@ +# GitHub Actions Checkout - AI Coding Instructions + +## Project Overview + +This is the official `actions/checkout` GitHub Action for checking out repositories in workflows. It's a TypeScript project that compiles to a single bundled JavaScript file (`dist/index.js`) and supports both git-based and REST API-based repository downloads. + +## Architecture & Key Components + +### Core Entry Points +- **`src/main.ts`**: Main entry point with `run()` and `cleanup()` functions, determined by `stateHelper.IsPost` +- **`src/git-source-provider.ts`**: Primary orchestrator for repository acquisition (git vs REST API fallback) +- **`src/input-helper.ts`**: Input validation and GitHub Actions input processing +- **`action.yml`**: Defines the action interface with comprehensive input/output schema + +### Critical Data Flow +1. `main.ts` → `inputHelper.getInputs()` → validates and transforms action inputs +2. `main.ts` → `gitSourceProvider.getSource(settings)` → orchestrates repository download +3. `git-source-provider.ts` decides: use Git CLI or fallback to GitHub REST API +4. State management via `state-helper.ts` for POST action cleanup + +### Authentication & Security Patterns +- **Token-based auth**: Uses `@actions/core` to handle GitHub tokens securely +- **SSH key management**: Configures temporary SSH keys in `git-auth-helper.ts` +- **Safe directory**: Automatically configures `git config safe.directory` for container compatibility + +## Development Workflow + +### Essential Commands +```bash +npm ci # Install dependencies +npm run build # TypeScript → JavaScript + bundle with ncc + generate docs +npm run format # Prettier formatting +npm run lint # ESLint validation +npm test # Jest test suite +``` + +### Build Process (Critical!) +- **`npm run build`** runs: `tsc && ncc build && node lib/misc/generate-docs.js` +- **Documentation sync**: `src/misc/generate-docs.ts` auto-updates README.md usage section from `action.yml` +- **Bundling**: Uses `@vercel/ncc` to create single `dist/index.js` file +- **Always run `npm run build` before commits** - the `dist/` directory must be up-to-date + +### Testing Strategy +- **Unit tests**: Jest tests in `__test__/` for all core modules +- **Integration tests**: Shell scripts (`__test__/verify-*.sh`) test real git operations +- **E2E tests**: `.github/workflows/test.yml` tests across OS matrix with actual GitHub repos + +## Project-Specific Conventions + +### TypeScript Patterns +- **Interface-driven**: `IGitSourceSettings` centralizes all configuration +- **Async/await**: All I/O operations use async patterns, not promises +- **Error handling**: Use `core.setFailed()` for action failures, `core.warning()` for non-critical issues + +### Git Operation Patterns +```typescript +// Check Git version and fallback pattern +const git = await getGitCommandManager(settings) +if (git) { + // Use Git CLI + await git.fetch(refSpec, fetchDepth) +} else { + // Fallback to REST API + await githubApiHelper.downloadRepository(...) +} +``` + +### State Management (Unique Pattern!) +- **Dual-phase execution**: Same script runs twice (MAIN + POST) determined by `stateHelper.IsPost` +- **State persistence**: Use `core.saveState()` / `core.getState()` to pass data between phases +- **Cleanup responsibility**: POST phase cleans up auth tokens, SSH keys, etc. + +### Input Validation Approach +- **GitHub context integration**: Defaults repository from `github.context.repo` +- **Path safety**: Validates paths are within `GITHUB_WORKSPACE` +- **Flexible refs**: Handles branches, tags, SHAs, and PR refs uniformly + +## Integration Points + +### GitHub Actions SDK Usage +- **`@actions/core`**: Input/output, logging, state management +- **`@actions/github`**: GitHub context and API access +- **`@actions/exec`**: Git command execution +- **`@actions/io`**: File system operations + +### Git Integration +- **Version compatibility**: Minimum Git 2.18, with feature detection for sparse-checkout +- **Authentication modes**: Token-based (default) or SSH key-based +- **Advanced features**: LFS, submodules, sparse-checkout, partial clones + +### Container Support +- **Safe directory**: Critical for container workflows - auto-configures git safe.directory +- **Credential persistence**: Configures git credential helper for authenticated operations + +## Common Debugging Patterns + +### Enable Debug Logging +```yaml +steps: + - uses: actions/checkout@v5 + env: + ACTIONS_STEP_DEBUG: true +``` + +### REST API Fallback Testing +```bash +# Force REST API mode by overriding Git version +__test__/override-git-version.sh +``` + +### Authentication Issues +- Check `GITHUB_TOKEN` permissions: needs `contents: read` +- For private repos: requires PAT with repo access +- Container issues: verify safe.directory configuration + +## Key Files for Understanding +- `src/git-source-provider.ts` - Main orchestration logic +- `src/input-helper.ts` - Action interface and validation +- `src/git-auth-helper.ts` - Authentication and credential management +- `action.yml` - Complete input/output specification +- `.github/workflows/test.yml` - Comprehensive test scenarios \ No newline at end of file From 84bd6b238a99496d7b9d021bd7e1e4f6cb61300a Mon Sep 17 00:00:00 2001 From: alberto96a11 Date: Sat, 20 Sep 2025 00:13:20 -0600 Subject: [PATCH 4/5] modificad --- .github/copilot-instructions.md | 2 +- .github/workflows/deno.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 0430b07..54227f1 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -2,7 +2,7 @@ ## Project Overview -This is the official `actions/checkout` GitHub Action for checking out repositories in workflows. It's a TypeScript project that compiles to a single bundled JavaScript file (`dist/index.js`) and supports both git-based and REST API-based repository downloads. +This is the official `actions/checkout` GitHub Action for checking out repositories in workflows, now with added support for Deno workflow integration. It's a TypeScript project that compiles to a single bundled JavaScript file (`dist/index.js`) and supports both git-based and REST API-based repository downloads, as well as Deno-based workflow scenarios. ## Architecture & Key Components diff --git a/.github/workflows/deno.yml b/.github/workflows/deno.yml index 782af35..5e63be4 100644 --- a/.github/workflows/deno.yml +++ b/.github/workflows/deno.yml @@ -27,7 +27,7 @@ jobs: - name: Setup Deno # uses: denoland/setup-deno@v1 - uses: denoland/setup-deno@61fe2df320078202e33d7d5ad347e7dcfa0e8f31 # v1.1.2 + uses: denoland/setup-deno@v1.1.2 with: deno-version: v1.x From 94b4159221c4ee2c26ffcbef295727ceb8e393ca Mon Sep 17 00:00:00 2001 From: alberto96a11 Date: Mon, 6 Oct 2025 05:00:50 -0600 Subject: [PATCH 5/5] Add LICENSE file --- LICENSE | 213 +++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 196 insertions(+), 17 deletions(-) diff --git a/LICENSE b/LICENSE index a67dca8..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,22 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ -The MIT License (MIT) + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -Copyright (c) 2018 GitHub, Inc. and contributors + 1. Definitions. -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.