Skip to content

Readme.md

Latest commit

 

History

History
32 lines (23 loc) · 926 Bytes

Readme.md

File metadata and controls

32 lines (23 loc) · 926 Bytes
Raw

Make Code Archive

GitHub composite action that archives the repository calling it (including submodules) and uploads the result as a workflow artifact.

Usage

jobs:
  archive:
    runs-on: ubuntu-latest
    permissions:
      contents: read
    steps:
      - uses: Shamrock-code/action-make-code-archive@v1.1
        with:
          output_name: archive_name.tar.gz

Inputs

Name Required Description
output_name Yes Output archive filename and artifact name. Must end with .tar.gz.

Requirements

  • The action checks out the repository and initializes submodules, so it works whether or not the caller has already run actions/checkout.
  • Artifact upload uses the default GITHUB_TOKEN. Ensure the job has permission to upload artifacts (the default permissions in most workflows is sufficient).

License

MIT — see LICENSE.