From fe199509182b6eb20150ac43ae82f67aa8190e20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Mon, 10 Mar 2025 16:04:51 +0100 Subject: [PATCH 01/24] feat(tutorial): GitHub action to sync object storage Tutorial explaining how to create a GitHub action to sync with object storage --- .../index.mdx | 114 ++++++++++++++++++ 1 file changed, 114 insertions(+) create mode 100644 tutorials/cicd-github-action-object-storage-sync/index.mdx diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx new file mode 100644 index 0000000000..0fb6675bea --- /dev/null +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -0,0 +1,114 @@ +--- +meta: + title: Github Action Sync Object Storage + description: Github action explaining how to sync files content with a Storage account using a github action +content: + h1: Using Github action to Sync your files with Object Storage + paragraph: This page explains how to configure your github action to sync your files with an Object storage +tags: CI/CD Github Action Object Storage +categories: + - object-storage +dates: + validation: 2025-03-10 + posted: 2025-03-10 +--- + +## Tutorial: Deploying your content to Scaleway Object Storage Using GitHub Actions + +This tutorial will guide you through setting up a GitHub Action to deploy your Astro site to Scaleway Object Storage. We will use a GitHub Actions workflow to automate the deployment process whenever changes are pushed to the `main` branch. + +## Prerequisites + +- A GitHub repository with your Astro project. +- A Scaleway account with Object Storage configured. +- Scaleway API credentials (Access Key, Secret Key, Project ID, Organization ID). + +## Step 1: Create the GitHub Action Workflow + +1. In your GitHub repository, navigate to the `.github/workflows` directory. If it doesn't exist, create it. +2. Create a new file named `deploy.yml` in the `.github/workflows` directory. + +## Step 2: Define the Workflow + +Copy and paste the following code into the `deploy.yml` file. This workflow will run on every push to the `main` branch, build your Astro site, and upload the built files to Scaleway Object Storage. + +```yaml +name: Upload to Scaleway Object Storage + +on: + push: + branches: + - main # Change this to your default branch if different + +jobs: + upload: + environment: prd + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Node.js + uses: actions/setup-node@v2 + with: + node-version: '23' + + - name: Install dependencies + run: npm install + + - name: Build the website + run: npm run build + + - name: Install s3cmd + run: sudo apt-get install -y s3cmd + + - name: Install CLI + uses: scaleway/action-scw@v0 + with: + version: v2.37.0 + + - run: | + scw object config get type=s3cmd > /home/runner/.s3cfg + s3cmd --no-mime-magic --guess-mime-type sync ./dist/* s3://your_bucket_name/ + env: + SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }} + SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }} + SCW_DEFAULT_PROJECT_ID: ${{ secrets.SCW_DEFAULT_PROJECT_ID }} + SCW_DEFAULT_ORGANIZATION_ID: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }} +``` + +## Step 3: Configure Secrets + +In your GitHub repository, go to Settings > Secrets and variables > Actions. +Add the following secrets with your Scaleway credentials: + +- SCW_ACCESS_KEY +- SCW_SECRET_KEY +- SCW_DEFAULT_PROJECT_ID +- SCW_DEFAULT_ORGANIZATION_ID + +## Step 4: Commit and Push + +Commit and push the `deploy.yml` file to your repository. This will trigger the GitHub Action to run on the main branch. + +```bash +git add .github/workflows/deploy.yml +git commit -m "Add GitHub Action for deploying to Scaleway Object Storage" +git push origin main +``` +### Notes: + +#### Alternative Build Processes +If your project uses a different build process, replace the `Install dependencies`and `Build the website` steps with the appropriate commands for your environment. + +Here are some examples: +```python + - name: Install uv + uses: astral-sh/setup-uv@v5 + + - name: Install the project + run: uv sync --all-extras --dev + - name: Build the project + run: uv build +``` From e2f7535816f99929280e6f4faedbd5ff2048a3b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:27:07 +0100 Subject: [PATCH 02/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 0fb6675bea..ac75184e12 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -63,7 +63,7 @@ jobs: - name: Install s3cmd run: sudo apt-get install -y s3cmd - - name: Install CLI + - name: Install the Scaleway CLI uses: scaleway/action-scw@v0 with: version: v2.37.0 From 4a5b98c07e9b3122be3efac47f95ea52d00bea38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:29:26 +0100 Subject: [PATCH 03/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index ac75184e12..a08ad2de42 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -30,7 +30,7 @@ This tutorial will guide you through setting up a GitHub Action to deploy your A ## Step 2: Define the Workflow -Copy and paste the following code into the `deploy.yml` file. This workflow will run on every push to the `main` branch, build your Astro site, and upload the built files to Scaleway Object Storage. +Copy and paste the following code into the `deploy.yml` file. This workflow will run on every push to the `main` branch, build your Astro website, and upload the built files to Scaleway Object Storage. ```yaml name: Upload to Scaleway Object Storage From 506428db9212d167bc9f0d4af215c474df268ed3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:29:43 +0100 Subject: [PATCH 04/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index a08ad2de42..175cf822ce 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -97,7 +97,8 @@ git add .github/workflows/deploy.yml git commit -m "Add GitHub Action for deploying to Scaleway Object Storage" git push origin main ``` -### Notes: + +You can now access your website by clicking the **Website URL** from the **Settings** tab of your bucket in the [Scaleway console](https://console.scaleway.com/object-storage/buckets). #### Alternative Build Processes If your project uses a different build process, replace the `Install dependencies`and `Build the website` steps with the appropriate commands for your environment. From f0c23810a5a6b9a3f148c6cd0c9cb1ab77d531aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:29:52 +0100 Subject: [PATCH 05/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 175cf822ce..72055c2de0 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -100,7 +100,8 @@ git push origin main You can now access your website by clicking the **Website URL** from the **Settings** tab of your bucket in the [Scaleway console](https://console.scaleway.com/object-storage/buckets). -#### Alternative Build Processes +## Alternative build processes + If your project uses a different build process, replace the `Install dependencies`and `Build the website` steps with the appropriate commands for your environment. Here are some examples: From 21e470a7f03612bc252c9e675e6b8cfc710c8595 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:30:18 +0100 Subject: [PATCH 06/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 72055c2de0..b0e4896f68 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -102,10 +102,10 @@ You can now access your website by clicking the **Website URL** from the **Setti ## Alternative build processes -If your project uses a different build process, replace the `Install dependencies`and `Build the website` steps with the appropriate commands for your environment. +If your project uses a different build process, replace the `Install dependencies`and `Build the website` steps with the appropriate commands for your environment. The code below shows an example of an alternative build process using [Astral](https://astral.sh/). -Here are some examples: -```python + +```yaml - name: Install uv uses: astral-sh/setup-uv@v5 From 835cd1c75b07d946ef09a17cdc6486235b4e7a6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:53:19 +0100 Subject: [PATCH 07/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- .../cicd-github-action-object-storage-sync/index.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index b0e4896f68..998372e71f 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -1,11 +1,11 @@ --- meta: - title: Github Action Sync Object Storage - description: Github action explaining how to sync files content with a Storage account using a github action + title: Synchronizing your website with Object Storage using GitHub Actions + description: Learn how to automatically sync files from a GitHub repository with Scaleway Object Storage using GitHub Actions to deploy your website content: - h1: Using Github action to Sync your files with Object Storage - paragraph: This page explains how to configure your github action to sync your files with an Object storage -tags: CI/CD Github Action Object Storage + h1: Synchronizing your website with Object Storage using GitHub Actions + paragraph: Learn how to automatically sync files from a GitHub repository with Scaleway Object Storage using GitHub Actions to deploy your website +tags: ci cd github actions object storage s3cmd sync workflow categories: - object-storage dates: From 4dbf17928b8c84121518da4d7ff6bc11b32f9324 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:53:57 +0100 Subject: [PATCH 08/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 998372e71f..027280d035 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -13,7 +13,7 @@ dates: posted: 2025-03-10 --- -## Tutorial: Deploying your content to Scaleway Object Storage Using GitHub Actions +Deploying your content to Scaleway Object Storage Using GitHub Actions This tutorial will guide you through setting up a GitHub Action to deploy your Astro site to Scaleway Object Storage. We will use a GitHub Actions workflow to automate the deployment process whenever changes are pushed to the `main` branch. From cfda2c84aeab8513229fc11bbc549161b0419a0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:54:14 +0100 Subject: [PATCH 09/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 027280d035..b196b7573d 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -17,7 +17,7 @@ Deploying your content to Scaleway Object Storage Using GitHub Actions This tutorial will guide you through setting up a GitHub Action to deploy your Astro site to Scaleway Object Storage. We will use a GitHub Actions workflow to automate the deployment process whenever changes are pushed to the `main` branch. -## Prerequisites + - A GitHub repository with your Astro project. - A Scaleway account with Object Storage configured. From 111f23d747c22cc0a541ea9cd5dd6510d5eee317 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:55:46 +0100 Subject: [PATCH 10/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index b196b7573d..70047897fb 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -74,8 +74,8 @@ jobs: env: SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }} SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }} - SCW_DEFAULT_PROJECT_ID: ${{ secrets.SCW_DEFAULT_PROJECT_ID }} - SCW_DEFAULT_ORGANIZATION_ID: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }} + SCW_PROJECT_ID: ${{ secrets.SCW_PROJECT_ID }} + SCW_ORGANIZATION_ID: ${{ secrets.SCW_ORGANIZATION_ID }} ``` ## Step 3: Configure Secrets From 599f6d2e145bc9e442e1a4db5874abc60efa9d8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:56:00 +0100 Subject: [PATCH 11/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 70047897fb..d00f4ae0dd 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -19,9 +19,10 @@ This tutorial will guide you through setting up a GitHub Action to deploy your A -- A GitHub repository with your Astro project. -- A Scaleway account with Object Storage configured. -- Scaleway API credentials (Access Key, Secret Key, Project ID, Organization ID). +- A Scaleway account logged into the [console](https://console.scaleway.com) +- A [GitHub](https://github.com/) repository with your [Astro](https://astro.build/) project. +- A Scaleway Object Storage bucket with the [bucket website](/object-storage/how-to/use-bucket-website/) feature enabled +- Retrieved your Scaleway credentials ([API key](/iam/how-to/create-api-keys/), Project ID, Organization ID). ## Step 1: Create the GitHub Action Workflow From 44344c70849509d1151f95bcb3a17637760ef34a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:56:16 +0100 Subject: [PATCH 12/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index d00f4ae0dd..46f5b37dd9 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -79,7 +79,7 @@ jobs: SCW_ORGANIZATION_ID: ${{ secrets.SCW_ORGANIZATION_ID }} ``` -## Step 3: Configure Secrets +Configure repository secrets In your GitHub repository, go to Settings > Secrets and variables > Actions. Add the following secrets with your Scaleway credentials: From 2ad0c1a633ff7b50d7a4ae94bf5f05a9dac7116e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:56:29 +0100 Subject: [PATCH 13/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 46f5b37dd9..225dc44c35 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -86,8 +86,8 @@ Add the following secrets with your Scaleway credentials: - SCW_ACCESS_KEY - SCW_SECRET_KEY -- SCW_DEFAULT_PROJECT_ID -- SCW_DEFAULT_ORGANIZATION_ID +- SCW_PROJECT_ID +- SCW_ORGANIZATION_ID ## Step 4: Commit and Push From 690f418fcdcab744a696d08536c196f736c1bc7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:56:45 +0100 Subject: [PATCH 14/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 225dc44c35..fa23c2671a 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -89,7 +89,7 @@ Add the following secrets with your Scaleway credentials: - SCW_PROJECT_ID - SCW_ORGANIZATION_ID -## Step 4: Commit and Push +Commit and push your changes Commit and push the `deploy.yml` file to your repository. This will trigger the GitHub Action to run on the main branch. From a1f72698e8549b63beaa1e71d9fa76c5e4087aa5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 13:57:03 +0100 Subject: [PATCH 15/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index fa23c2671a..3d7b84223d 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -91,7 +91,7 @@ Add the following secrets with your Scaleway credentials: Commit and push your changes -Commit and push the `deploy.yml` file to your repository. This will trigger the GitHub Action to run on the main branch. +Run the commands below to commit and push the `deploy.yml` file to your repository. If you are working directly on your main branch, this will trigger the GitHub Action to run on the main branch. ```bash git add .github/workflows/deploy.yml From 43a85ef91d5dbfc8cde4d5ada34e9d0f723ef3ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 14:07:25 +0100 Subject: [PATCH 16/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 3d7b84223d..6f29627f1e 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -24,7 +24,7 @@ This tutorial will guide you through setting up a GitHub Action to deploy your A - A Scaleway Object Storage bucket with the [bucket website](/object-storage/how-to/use-bucket-website/) feature enabled - Retrieved your Scaleway credentials ([API key](/iam/how-to/create-api-keys/), Project ID, Organization ID). -## Step 1: Create the GitHub Action Workflow +Create the GitHub Actions Workflow 1. In your GitHub repository, navigate to the `.github/workflows` directory. If it doesn't exist, create it. 2. Create a new file named `deploy.yml` in the `.github/workflows` directory. From 0690faf7e491aa0ce5ad17e21ed2be6eb1998c56 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 14:08:08 +0100 Subject: [PATCH 17/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 6f29627f1e..acc352b9cb 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -26,7 +26,7 @@ This tutorial will guide you through setting up a GitHub Action to deploy your A Create the GitHub Actions Workflow -1. In your GitHub repository, navigate to the `.github/workflows` directory. If it doesn't exist, create it. +1. In your GitHub repository, navigate to the `.github/workflows` directory. If it does not exist, create it at the root of your repository. 2. Create a new file named `deploy.yml` in the `.github/workflows` directory. ## Step 2: Define the Workflow From ccc9783b85d2353c9e26b2b89a54f319c090209a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 14:08:32 +0100 Subject: [PATCH 18/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index acc352b9cb..913c69561f 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -29,7 +29,7 @@ Create the GitHub Actions Workflow 1. In your GitHub repository, navigate to the `.github/workflows` directory. If it does not exist, create it at the root of your repository. 2. Create a new file named `deploy.yml` in the `.github/workflows` directory. -## Step 2: Define the Workflow +Define the workflow Copy and paste the following code into the `deploy.yml` file. This workflow will run on every push to the `main` branch, build your Astro website, and upload the built files to Scaleway Object Storage. From c9f78fdf3f4bfc97ef3bda8534332c676e9076ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 14:08:51 +0100 Subject: [PATCH 19/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 913c69561f..8be4298496 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -39,7 +39,7 @@ name: Upload to Scaleway Object Storage on: push: branches: - - main # Change this to your default branch if different + - main # Change this to your default branch if different (e.g. "trunk", or "master") jobs: upload: From 93213349ebb7cefb04ed0e889897796ada3a1c89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 14:09:18 +0100 Subject: [PATCH 20/24] Update tutorials/cicd-github-action-object-storage-sync/index.mdx Co-authored-by: SamyOubouaziz --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 8be4298496..ecce0d2780 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -47,7 +47,7 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout code + - name: Checkout repository uses: actions/checkout@v2 - name: Set up Node.js From b76035f2d765f4f7efcf4446d5c089b4803491fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 21 Mar 2025 14:11:52 +0100 Subject: [PATCH 21/24] Update index.mdx Add additional section + change checkout version --- .../cicd-github-action-object-storage-sync/index.mdx | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index ecce0d2780..3708eceb51 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -43,12 +43,11 @@ on: jobs: upload: - environment: prd runs-on: ubuntu-latest steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Set up Node.js uses: actions/setup-node@v2 @@ -115,3 +114,11 @@ If your project uses a different build process, replace the `Install dependencie - name: Build the project run: uv build ``` + +## Troubleshooting and additional resources + +- If you encounter issues while using your API key with Scaleway Object Storage, refer to the [dedicated troubleshooting](/object-storage/troubleshooting/api-key-does-not-work/). + +- Refer to the [official GitHub Actions documentation](https://docs.github.com/en/actions/writing-workflows/quickstart) for more information on how to create and run workflows. + +- Learn how to better secure your deployment by properly [setting up IAM and Object Storage](/object-storage/api-cli/combining-iam-and-object-storage/) From 9b910ce6898a63f648dccd9367da1dd2adf48653 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 28 Mar 2025 17:31:42 +0100 Subject: [PATCH 22/24] Update index.mdx Co-authored-by: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 3708eceb51..6e8e4713fe 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -29,7 +29,7 @@ Create the GitHub Actions Workflow 1. In your GitHub repository, navigate to the `.github/workflows` directory. If it does not exist, create it at the root of your repository. 2. Create a new file named `deploy.yml` in the `.github/workflows` directory. -Define the workflow +## Defining the workflow Copy and paste the following code into the `deploy.yml` file. This workflow will run on every push to the `main` branch, build your Astro website, and upload the built files to Scaleway Object Storage. From d85ca40129003aa033d4ed04e16528a69c20c359 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Lejoly?= <57676655+LLejoly@users.noreply.github.com> Date: Fri, 28 Mar 2025 17:31:49 +0100 Subject: [PATCH 23/24] Update index.mdx Co-authored-by: ldecarvalho-doc <82805470+ldecarvalho-doc@users.noreply.github.com> --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index 6e8e4713fe..a95ff0d13b 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -24,7 +24,7 @@ This tutorial will guide you through setting up a GitHub Action to deploy your A - A Scaleway Object Storage bucket with the [bucket website](/object-storage/how-to/use-bucket-website/) feature enabled - Retrieved your Scaleway credentials ([API key](/iam/how-to/create-api-keys/), Project ID, Organization ID). -Create the GitHub Actions Workflow +## Creating the GitHub Actions Workflow 1. In your GitHub repository, navigate to the `.github/workflows` directory. If it does not exist, create it at the root of your repository. 2. Create a new file named `deploy.yml` in the `.github/workflows` directory. From 87913f1869ddf0d44350b395e64bc9eb1d95246f Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Mon, 31 Mar 2025 11:11:46 +0200 Subject: [PATCH 24/24] Apply suggestions from code review Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> --- tutorials/cicd-github-action-object-storage-sync/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index a95ff0d13b..2a8959e11b 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -102,7 +102,7 @@ You can now access your website by clicking the **Website URL** from the **Setti ## Alternative build processes -If your project uses a different build process, replace the `Install dependencies`and `Build the website` steps with the appropriate commands for your environment. The code below shows an example of an alternative build process using [Astral](https://astral.sh/). +If your project uses a different build process, replace the `Install dependencies` and `Build the website` steps with the appropriate commands for your environment. The code below shows an example of an alternative build process using [Astral](https://astral.sh/). ```yaml @@ -121,4 +121,4 @@ If your project uses a different build process, replace the `Install dependencie - Refer to the [official GitHub Actions documentation](https://docs.github.com/en/actions/writing-workflows/quickstart) for more information on how to create and run workflows. -- Learn how to better secure your deployment by properly [setting up IAM and Object Storage](/object-storage/api-cli/combining-iam-and-object-storage/) +- Learn how to better secure your deployment by properly [setting up IAM and Object Storage](/object-storage/api-cli/combining-iam-and-object-storage/).