Merge branch 'main' into 361_exclude_symlink_directories_skips_other_dirs

Author: metmikel

.changes/unreleased/FEATURES-20240912-140136.yaml

@@ -0,0 +1,5 @@
+kind: FEATURES
+body: 'resource/archive_file: Remove `deprecated` status'
+time: 2024-09-12T14:01:36.373922-04:00
+custom:
+    Issue: "218"

.github/workflows/ci-changie.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Ensure terraform-devex-repos is updated on version changes.
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       # Ensure terraform-devex-repos is updated on version changes.
       - uses: miniscruff/changie-action@6dcc2533cac0495148ed4046c438487e4dceaa23 # v2.0.0
         with:

.github/workflows/compliance.yml

@@ -11,7 +11,7 @@ jobs:
   copywrite:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - uses: hashicorp/setup-copywrite@32638da2d4e81d56a0764aa1547882fc4d209636 # v1.1.3
       - run: copywrite headers --plan
       - run: copywrite license --plan

.github/workflows/issue-opened.yml

@@ -8,7 +8,7 @@ jobs:
   issue_triage:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - uses: github/issue-labeler@c1b0f9f52a63158c4adc09425e858e87b32e9685 # v3.4
       with:
         repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/pull-request.yml

@@ -15,7 +15,7 @@ jobs:
       with:
         configuration-path: .github/labeler-pull-request-triage.yml
         repo-token: "${{ secrets.GITHUB_TOKEN }}"
-    - uses: CodelyTV/pr-size-labeler@56f6f0fc35c7cc0f72963b8467729e1120cb4bed # v1.10.0
+    - uses: CodelyTV/pr-size-labeler@c7a55a022747628b50f3eb5bf863b9e796b8f274 # v1.10.1
       with:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         xs_label: 'size/XS'

.github/workflows/release.yml

@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           fetch-depth: 0
           # Avoid persisting GITHUB_TOKEN credentials as they take priority over our service account PAT for `git push` operations
@@ -57,7 +57,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           fetch-depth: 0
           # Default input is the SHA that initially triggered the workflow. As we created a new commit in the previous job,
@@ -79,7 +79,7 @@ jobs:
     needs: [ changelog-version, changelog, release-tag ]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           ref: ${{ inputs.versionNumber }}
           fetch-depth: 0
@@ -89,7 +89,7 @@ jobs:
           cd .changes
           sed -e "1{/# /d;}" -e "2{/^$/d;}" ${{ needs.changelog-version.outputs.version }}.md > release-notes.txt
 
-      - uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
+      - uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
         with:
           name: release-notes
           path: ./.changes/release-notes.txt

.github/workflows/test.yml

@@ -20,19 +20,25 @@ jobs:
     steps:
 
     - name: Check out code into the Go module directory
-      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
     - name: Set up Go
-      uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2
+      uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
       with:
         go-version-file: 'go.mod'
       id: go
 
     - name: Run linters
-      uses: golangci/golangci-lint-action@aaa42aa0628b4ae2578232a66b541047968fac86 # v6.1.0
+      uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6.1.1
       with:
         version: latest
 
+    # We need the latest version of Terraform for our documentation generation to use
+    - name: Set up Terraform
+      uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3.1.2
+      with:
+        terraform_wrapper: false
+
     - name: Generate
       run: make generate
 
@@ -62,10 +68,10 @@ jobs:
     steps:
 
       - name: Check out code
-        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Setup Go
-        uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2
+        uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
         with:
           go-version-file: 'go.mod'
           check-latest: true

DESIGN.md

@@ -1,15 +1,15 @@
 # Archive Provider Design
 
-The Archive Provider offers focussed functionality specifically geared towards archiving files. Specifically, 
-the provider data source generates zip archives of individual or multiple files. 
+The Archive Provider offers focussed functionality specifically geared towards archiving files. The provider generates
+zip archives of individual or multiple files.
 
 Below we have a collection of _Goals_ and _Patterns_: they represent the guiding principles applied during the
 development of this provider. Some are in place, others are ongoing processes, others are still just inspirational.
 
 ## Goals
 
 * [_Stability over features_](.github/CONTRIBUTING.md)
-* Provide data source for generating zip archives.
+* Provide a mechanism for generating zip archives.
 
 General to development:
 

docs/cdktf/python/data-sources/file.md

@@ -2,14 +2,14 @@
 page_title: "archive_file Data Source - terraform-provider-archive"
 subcategory: ""
 description: |-
-  Generates an archive from content, a file, or directory of files.
+  Generates an archive from content, a file, or directory of files. The archive is built during the terraform plan, so you must persist the archive through to the terraform apply. See the archive_file resource for an alternative if you cannot persist the file, such as in a multi-phase CI or build server context.
 ---
 
 
 <!-- Please do not edit this file, it is generated. -->
 # archive_file (Data Source)
 
-Generates an archive from content, a file, or directory of files.
+Generates an archive from content, a file, or directory of files. The archive is built during the terraform plan, so you must persist the archive through to the terraform apply. See the `archive_file` resource for an alternative if you cannot persist the file, such as in a multi-phase CI or build server context.
 
 ## Example Usage
 
@@ -117,4 +117,4 @@ Required:
 - `content` (String) Add this content to the archive with `filename` as the filename.
 - `filename` (String) Set this as the filename when declaring a `source`.
 
-<!-- cache-key: cdktf-0.20.1 input-e028531bc97a019f848b3e37c5dde395799324b83b8cd5ea78649ffc9177c542 -->
+<!-- cache-key: cdktf-0.20.8 input-58f16fa5c1a288eadc3103ca8daf35401729e7a632b0a84dc82a5c5d959b0602 -->

docs/cdktf/python/index.md

@@ -12,4 +12,4 @@ The archive provider exposes resources to manage archive files.
 
 This provider requires no configuration. For information on the resources
 it provides, see the navigation bar.
-<!-- cache-key: cdktf-0.20.1 input-29729bd5dcf423357d35fb88a589120ee1e2d5d1677702061afe3d70700dddc8 -->
+<!-- cache-key: cdktf-0.20.8 input-29729bd5dcf423357d35fb88a589120ee1e2d5d1677702061afe3d70700dddc8 -->