Merge pull request #1 from Swile/swile-network-mirror

Setup Terraform Provider Network Mirror with GitHub Pages

Author: jBouyoud

.github/workflows/golangci.yml

@@ -12,10 +12,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v5
 
-      - name: Setup Go
-        uses: actions/setup-go@v5
+      - uses: actions/setup-go@v6
         with:
-          go-version: 1.24.x
+          cache: true
+          cache-dependency-path: 'go.sum'
+          go-version-file: 'go.mod'
 
       - run: go mod vendor
 

.github/workflows/release.yml

@@ -1,47 +1,133 @@
 # This GitHub action can publish assets for release when a tag is created.
 # Currently its setup to run on any tag that matches the pattern "v*" (ie. v0.1.0).
 #
-# This uses an action (paultyng/ghaction-import-gpg) that assumes you set your 
+# This uses an action (paultyng/ghaction-import-gpg) that assumes you set your
 # private key in the `GPG_PRIVATE_KEY` secret and passphrase in the `PASSPHRASE`
 # secret. If you would rather own your own GPG handling, please fork this action
 # or use an alternative one for key handling.
 #
-# You will need to pass the `--batch` flag to `gpg` in your signing step 
+# You will need to pass the `--batch` flag to `gpg` in your signing step
 # in `goreleaser` to indicate this is being used in a non-interactive mode.
 #
 name: release
 on:
   push:
     tags:
       - 'v*'
+
+concurrency:
+  # Allow only run per ref
+  # Mitigate https://intuit.github.io/auto/docs/welcome/quick-merge
+  group: ${{ github.workflow }}-${{ github.ref }}
+
 jobs:
   goreleaser:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       -
         name: Unshallow
         run: git fetch --prune --unshallow
-      -
-        name: Set up Go
-        uses: actions/setup-go@v5
-        with:
-          go-version: '1.24'
-      -
-        name: Import GPG key
-        id: import_gpg
-        uses: crazy-max/ghaction-import-gpg@v6.1.0
+
+      - uses: actions/setup-go@v6
         with:
-          gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
-          passphrase: ${{ secrets.PASSPHRASE }}
+          cache: true
+          cache-dependency-path: 'go.sum'
+          go-version-file: 'go.mod'
+      # -
+      #   name: Import GPG key
+      #   id: import_gpg
+      #   uses: crazy-max/ghaction-import-gpg@v6.1.0
+      #   with:
+      #     gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+      #     passphrase: ${{ secrets.PASSPHRASE }}
       -
         name: Run GoReleaser
+        id: release
         uses: goreleaser/goreleaser-action@v6
         with:
           version: latest
           args: release --clean
         env:
-          GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          #GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
+          GITHUB_TOKEN: ${{ github.token }}
+
+  publish-mirror:
+    needs: goreleaser
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    env:
+      NAMESPACE: 'cyrilgdn'
+      PROVIDER_NAME: 'postgresql'
+      REGISTRY: 'registry.terraform.io'
+      MIRROR_DIR: 'mirror'
+    steps:
+      - name: Set VERSION from tag
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          echo "VERSION=$VERSION" >> "$GITHUB_ENV"
+
+      - uses: actions/checkout@v6
+
+      - uses: actions/checkout@v6
+        with:
+          ref: gh-pages
+          path: gh-pages
+
+      - name: Download release artifacts
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          echo "Downloading artifacts for version ${VERSION}"
+          MIRROR_VERSION_DIR="${{env.MIRROR_DIR}}/${{env.REGISTRY}}/${{env.NAMESPACE}}/${{env.PROVIDER_NAME}}/${{env.VERSION}}"
+
+          # Create directory structure for network mirror
+          mkdir -p "${MIRROR_VERSION_DIR}"
+
+          # Download release assets
+          gh release download "v${VERSION}" -D "${MIRROR_VERSION_DIR}"
+
+      - name: Generate network mirror metadata
+        run: |
+          # Make script executable
+          chmod +x scripts/generate-mirror-metadata.sh
+
+          # Generate metadata
+          ./scripts/generate-mirror-metadata.sh "${VERSION}" "${NAMESPACE}" "${PROVIDER_NAME}" "${MIRROR_DIR}/${REGISTRY}"
+
+          # Update root simple index.html
+          cp -f ./docs/mirror-index.html ${MIRROR_DIR}/index.html
+          
+          # Update gh-pages content
+          cp -r ${MIRROR_DIR}/* ./gh-pages/
+
+      - name: Commit and push to gh-pages
+        run: |
+          cd gh-pages
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add .
+          git commit -m "Release version ${VERSION}" || echo "No changes to commit"
+          git push origin gh-pages
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./gh-pages
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/test.yml

@@ -19,12 +19,13 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
-      - name: Set up Go
-        uses: actions/setup-go@v5
+      - uses: actions/setup-go@v6
         with:
-          go-version: '1.24'
+          cache: true
+          cache-dependency-path: 'go.sum'
+          go-version-file: 'go.mod'
 
       - name: test
         run: make test

.gitignore

@@ -5,3 +5,6 @@
 .*.swp
 tests/docker-compose.*.yml
 terraform-provider-postgresql
+
+# Network mirror artifacts (deployed to gh-pages)
+mirror/

.go-version

@@ -29,25 +29,29 @@ builds:
   ignore:
     - goos: darwin
       goarch: '386'
+    - goos: windows
+      goarch: arm
+    - goos: windows
+      goarch: arm64
   binary: '{{ .ProjectName }}_v{{ .Version }}'
 archives:
-- format: zip
+- formats: ['zip']
   name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}'
 checksum:
   name_template: '{{ .ProjectName }}_{{ .Version }}_SHA256SUMS'
   algorithm: sha256
-signs:
-  - artifacts: checksum
-    args:
-      # if you are using this is a GitHub action or some other automated pipeline, you
-      # need to pass the batch flag to indicate it's not interactive.
-      - "--batch"
-      - "--local-user"
-      - "{{ .Env.GPG_FINGERPRINT }}" # set this environment variable for your signing key
-      - "--output"
-      - "${signature}"
-      - "--detach-sign"
-      - "${artifact}"
+#signs:
+#  - artifacts: checksum
+#    args:
+#      # if you are using this is a GitHub action or some other automated pipeline, you
+#      # need to pass the batch flag to indicate it's not interactive.
+#      - "--batch"
+#      - "--local-user"
+#      - "{{ .Env.GPG_FINGERPRINT }}" # set this environment variable for your signing key
+#      - "--output"
+#      - "${signature}"
+#      - "--detach-sign"
+#      - "${artifact}"
 release: {}
   # If you want to manually examine the release before its live, uncomment this line:
   # draft: true

.goreleaser.yml

@@ -1,6 +1,18 @@
 Terraform Provider for PostgreSQL
 =================================
 
+Fork of Terraform PostgreSQL provider : https://github.com/cyrilgdn/terraform-provider-postgresql
+
+This intent of this fork is to maintain a working version of the provider while waiting for the original repository to be updated.
+
+This repository aims to be up to date with the original one, and also to add some features that are needed for our use cases.
+We re-integrated the following PRs that were open on the original repository:
+
+- [Use object-level locks for concurrent grants to improve parallelism](https://github.com/cyrilgdn/terraform-provider-postgresql/pull/595)
+- [Support role configuration parameters](https://github.com/cyrilgdn/terraform-provider-postgresql/pull/305)
+
+---
+
 This provider allows to manage with Terraform [Postgresql](https://www.postgresql.org/) objects like databases, extensions, roles, etc.
 
 It's published on the [Terraform registry](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs).
@@ -36,6 +48,27 @@ Using the provider
 
 Usage examples can be found in the Terraform [provider documentation](https://www.terraform.io/docs/providers/postgresql/index.html)
 
+Network Mirror
+----------------------
+
+This repository publishes a [Terraform provider network mirror](docs/NETWORK_MIRROR.md) on GitHub Pages, allowing you to use this provider without relying on external registries.
+
+**Quick setup:**
+
+Add to your `~/.terraformrc`:
+
+```hcl
+provider_installation {
+  network_mirror {
+    url = "https://swile.github.io/terraform-provider-postgresql/"
+    include = ["registry.terraform.io/cyrilgdn/postgresql"]
+  }
+}
+```
+
+See the [Network Mirror documentation](docs/NETWORK_MIRROR.md) for more details.
+
+
 Developing the Provider
 ---------------------------
 
@@ -58,7 +91,7 @@ $ make test
 
 In order to run the full suite of Acceptance tests, run `make testacc`.
 
-*Note:* 
+*Note:*
 - Acceptance tests create real resources, and often cost money to run.
 
 ```sh
@@ -68,7 +101,7 @@ $ make testacc
 In order to manually run some Acceptance test locally, run the following commands:
 ```sh
 # spins up a local docker postgres container
-make testacc_setup 
+make testacc_setup
 
 # Load the needed environment variables for the tests
 source tests/switch_superuser.sh
@@ -77,5 +110,5 @@ source tests/switch_superuser.sh
 TF_LOG=INFO go test -v ./postgresql -run ^TestAccPostgresqlRole_Basic$
 
 # cleans the env and tears down the postgres container
-make testacc_cleanup 
+make testacc_cleanup
 ```