From e11d2a71b1e4980a4402a178962f0d3698f558a5 Mon Sep 17 00:00:00 2001 From: Daniel La Rubia Date: Sun, 6 Jul 2025 09:04:13 -0300 Subject: [PATCH 1/2] chore: update links and project name --- docusaurus.config.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docusaurus.config.ts b/docusaurus.config.ts index e347fb4..79df9a2 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -23,7 +23,7 @@ const config: Config = { // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. organizationName: 'opiasec', // Usually your GitHub org/user name. - projectName: 'appseclabs', // Usually your repo name. + projectName: 'documentation', // Usually your repo name. onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', @@ -66,7 +66,7 @@ const config: Config = { // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + 'https://github.com/AppSec-Digital/documentation/tree/main/', }, blog: { showReadingTime: true, @@ -77,7 +77,7 @@ const config: Config = { // Please change this to your repo. // Remove this to remove the "edit this page" links. editUrl: - 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/', + 'https://github.com/AppSec-Digital/documentation/tree/main/', // Useful options to enforce blogging best practices onInlineTags: 'warn', onInlineAuthors: 'warn', @@ -152,12 +152,12 @@ const config: Config = { }, { label: 'GitHub', - href: 'https://github.com/facebook/docusaurus', + href: 'https://github.com/opiasec/documentation', }, ], }, ], - copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`, + copyright: `Copyright © ${new Date().getFullYear()} opiasec. Built with Docusaurus.`, }, prism: { theme: prismThemes.github, From 87742f3eaeb23ca460250641ac8b1ba10959546f Mon Sep 17 00:00:00 2001 From: Daniel La Rubia Date: Sun, 6 Jul 2025 09:04:33 -0300 Subject: [PATCH 2/2] feat: add cd pipeline (github pages) --- .github/workflows/cd.yml | 50 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/workflows/cd.yml diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml new file mode 100644 index 0000000..32d0662 --- /dev/null +++ b/.github/workflows/cd.yml @@ -0,0 +1,50 @@ +name: CD - Deploy Docusaurus to GitHub Pages + +on: + push: + branches: + - main + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Node.js + uses: actions/setup-node@v4 + with: + node-version: '22' + cache: 'npm' + + - name: Install dependencies + run: npm ci + + - name: Build Docusaurus site + run: npm run build + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: './build' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4