-
-
Notifications
You must be signed in to change notification settings - Fork 6
feat: Update StudioCMS configuration and documentation for beta.31 #177
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
71 commits
Select commit
Hold shift + click to select a range
1bc6f33
feat: Update StudioCMS configuration and documentation
Adammatthiesen d57459c
feat: add '@withstudiocms/kysely' to ignored dependencies in Knip config
Adammatthiesen 32d4bcd
feat: update error codes in ec.config and set preferredImageService t…
Adammatthiesen a1dfd29
feat: enable pre-release mode for generating release notes
Adammatthiesen d97ce99
feat: update CMS description and tagline, adjust analytics script URL…
Adammatthiesen c44cd9b
feat: add upgrade guide for StudioCMS Beta.31 with new badge
Adammatthiesen 40ae6ae
feat: update features and locale documentation with new security and …
Adammatthiesen 67d741a
feat: remove Kysely migration guide documentation
Adammatthiesen a964a8f
feat: hide sidebar entries for upgrade guides from Beta.16 to Beta.24…
Adammatthiesen 0c89072
feat: enhance package catalog display with no packages message and re…
Adammatthiesen 5b22b47
feat: add hidden property to package catalog schema and filter out hi…
Adammatthiesen 3aedc86
feat: add topic property to upgrade guides and set sidebar entries as…
Adammatthiesen de319de
fix: update web vitals guide link in upgrade guides for Beta.19 and B…
Adammatthiesen 1456dc1
fix: update web vitals guide link in upgrade guides for Beta.19 and B…
Adammatthiesen 2c044b2
fix: update migration command to include --latest flag in getting sta…
Adammatthiesen 179d647
feat: add webVitals feature for performance tracking and update upgra…
Adammatthiesen b089c93
fix: refine debug utilities description in upgrade guide for version …
Adammatthiesen cd74726
feat: update StarlightPage integration and adjust frontmatter in vari…
Adammatthiesen eb1873c
feat: add AdBanner component and integrate it into the PageSidebar la…
Adammatthiesen 083752c
fix: remove unused imports from AdBanner component
Adammatthiesen 5defd54
fix: update border color in AdBanner component to use accent color
Adammatthiesen a751470
feat: add initial nginx configuration file
Adammatthiesen 309b2ad
fix: remove unused start script from package.json
Adammatthiesen 4236783
feat: add nixpacks configuration for Node.js and Nginx setup
Adammatthiesen 60fe79e
fix: correct formatting in nginx.conf and nixpacks.toml
Adammatthiesen 9378c73
fix: update nixpacks configuration to use proto and streamline instal…
Adammatthiesen 07dce26
fix: update nixpacks.toml to include nginx in setup and adjust start …
Adammatthiesen b937423
fix: update nixpacks.toml to include pnpm in setup and adjust install…
Adammatthiesen 50ccf96
fix: update nixpacks.toml to revert to nodejs_24 and remove proto com…
Adammatthiesen 64d22b0
fix: update nixpacks.toml to revert nodejs version from 24 to 22
Adammatthiesen 72612c5
fix: update nixpacks.toml to correct nginx configuration file path an…
Adammatthiesen 3f852d7
fix: update nginx.conf to configure server settings and improve error…
Adammatthiesen 3ee49ac
fix: update contributor configuration and filtering logic to include …
Adammatthiesen 7aa4d44
fix: update upgrade guide and getting started documentation to includ…
Adammatthiesen 7230d86
fix: update configuration and getting started documentation for clari…
Adammatthiesen 2c4c274
fix: correct wording in migration tool instructions for clarity
Adammatthiesen dce75ce
feat: add CI workflows for Docker image publishing and configure Dock…
Adammatthiesen 9ca703b
fix: update CI workflows to restrict Docker build platforms to linux/…
Adammatthiesen 933ed2e
feat: add deployment request step to CI workflow for Docker image
Adammatthiesen ae33346
fix: add comment to clarify temporary deployment request step in CI w…
Adammatthiesen e7f11f9
chore: remove nixpacks configuration file
Adammatthiesen df0c740
feat: add new CLI command for debugging and update CLI documentation
Adammatthiesen 6cffb81
fix: correct markdown links for migrator and upgrade CLI commands
Adammatthiesen d329a20
feat: add image and tag data to deployment request in CI workflow
Adammatthiesen 3fafed8
feat: update deployment process to use DOKPLOY API for compose update…
Adammatthiesen 9988244
feat: enhance CI workflow to include deployment title and description…
Adammatthiesen 7a3171e
feat: add @withstudiocms/template-lang package and documentation
Adammatthiesen 4946f04
feat: add Custom Frontend Guides section with rendering options
Adammatthiesen ece6d3b
feat: add @withstudiocms/template-lang to ignored dependencies in Kni…
Adammatthiesen ac749fa
feat: update concurrency configuration in CI workflows for better job…
Adammatthiesen 4390c80
feat: standardize concurrency configuration in CI workflows
Adammatthiesen e0f03a6
feat: add section on building a custom frontend with StudioCMS
Adammatthiesen 55e0469
feat: enhance documentation with further reading sections and improve…
Adammatthiesen c6b9143
feat: add TODO for Core Features section and documentation of built-i…
Adammatthiesen 786bc1e
feat: add further reading sections and enhance documentation for SDK …
Adammatthiesen a2e0fe3
feat: add caution notice for revisions in the Getting Started guide f…
Adammatthiesen 46b5da0
feat: clarify caution notice for revisions in the Getting Started gui…
Adammatthiesen c440e07
feat: remove emoji from features list in Template Language documentation
Adammatthiesen 200a122
feat: reorder utils entry in configuration for better clarity
Adammatthiesen 2f833d8
feat: enhance clarity in authentication section and update provider l…
Adammatthiesen 8a5fd79
feat: add optional environment variables section with log level confi…
Adammatthiesen f8a2551
feat: add optional environment variables section to customize StudioC…
Adammatthiesen 30512a5
feat: add starlight-llms-txt dependency and integrate into configuration
Adammatthiesen b4d9326
feat: enhance starlightLlmsTxt integration with detailed descriptions…
Adammatthiesen e7e1e90
feat: update path for Getting Started resources to include language p…
Adammatthiesen b520f0b
feat: update deployment process to use DOKPLOY API for compose update…
Adammatthiesen 751d740
fix: switch pre-release mode off for generating release notes
Adammatthiesen c04f8b8
fix: update authorization method to use Bearer token for API requests
Adammatthiesen 59c7517
feat: add Commit interface and related types for GitHub commit details
Adammatthiesen 5f12a18
fix: remove unused Commit interface import from getContributors.ts
Adammatthiesen c906e0f
Refactor code structure for improved readability and maintainability
Adammatthiesen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| name: Publish Docker image to GHCR | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| packages: write | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build-and-push: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v5 | ||
|
|
||
| - name: Set up QEMU (for multi-arch) | ||
| uses: docker/setup-qemu-action@v3 | ||
|
|
||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v3 | ||
|
|
||
| - name: Cache pnpm store | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.pnpm-store | ||
| key: ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-pnpm- | ||
|
|
||
| - name: Login to GitHub Container Registry | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| registry: ghcr.io | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Build and push image | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| context: . | ||
| file: ./Dockerfile | ||
| platforms: linux/amd64 | ||
| push: true | ||
| secrets: | | ||
| "public_github_token=${{ secrets.PUBLIC_GITHUB_TOKEN }}" | ||
| tags: | | ||
| ghcr.io/${{ github.repository_owner }}/studiocms-docs:latest | ||
| ghcr.io/${{ github.repository_owner }}/studiocms-docs:${{ github.sha }} | ||
| ghcr.io/${{ github.repository_owner }}/studiocms-docs:${{ github.ref_name }} | ||
| cache-from: type=registry,ref=ghcr.io/${{ github.repository_owner }}/studiocms-docs-main:cache | ||
| cache-to: type=inline | ||
|
|
||
| - name: Verify pushed image | ||
| run: | | ||
| echo "Pushed: ghcr.io/${{ github.repository_owner }}/studiocms-docs:latest" | ||
| echo "Pushed: ghcr.io/${{ github.repository_owner }}/studiocms-docs:${{ github.sha }}" | ||
| echo "Pushed: ghcr.io/${{ github.repository_owner }}/studiocms-docs:${{ github.ref_name }}" | ||
|
|
||
| - name: Send compose update | ||
| run: | | ||
| response=$(curl -X 'POST' "${{ secrets.DOKPLOY_API_URL }}/compose.update" -H 'accept: application/json' -H 'Content-Type: application/json' -H "x-api-key: ${{ secrets.DOKPLOY_API_KEY }}" -d '{ | ||
| "composeId": "${{ secrets.DOKPLOY_COMPOSE_ID }}", | ||
| "composeFile": "services:\n docs:\n image: ghcr.io/withstudiocms/studiocms-docs:${{ github.sha }}\n restart: always" | ||
| }' | jq -r '.message') | ||
| echo "output_data=$response" >> $GITHUB_OUTPUT | ||
|
|
||
| - name: Trigger compose deploy | ||
| run: | | ||
| response=$(curl -X 'POST' "${{ secrets.DOKPLOY_API_URL }}/compose.deploy" -H 'accept: application/json' -H 'Content-Type: application/json' -H "x-api-key: ${{ secrets.DOKPLOY_API_KEY }}" -d '{ | ||
| "composeId": "${{ secrets.DOKPLOY_COMPOSE_ID }}", | ||
| "title": "Deploy from CI", | ||
| "description": "Deploying the latest changes from the CI pipeline. sha: ${{ github.sha }}" | ||
| }' | jq -r '.message') | ||
| echo "output_data=$response" >> $GITHUB_OUTPUT | ||
|
Adammatthiesen marked this conversation as resolved.
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| name: Publish Docker image to GHCR | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [main] | ||
| workflow_dispatch: | ||
|
|
||
| permissions: | ||
| contents: read | ||
| packages: write | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| build-and-push: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v5 | ||
|
|
||
| - name: Set up QEMU (for multi-arch) | ||
| uses: docker/setup-qemu-action@v3 | ||
|
|
||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v3 | ||
|
|
||
| - name: Cache pnpm store | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.pnpm-store | ||
| key: ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }} | ||
| restore-keys: | | ||
| ${{ runner.os }}-pnpm- | ||
|
|
||
| - name: Login to GitHub Container Registry | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| registry: ghcr.io | ||
| username: ${{ github.actor }} | ||
| password: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Build and push image | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| context: . | ||
| file: ./Dockerfile | ||
| platforms: linux/amd64 | ||
| push: true | ||
| secrets: | | ||
| "public_github_token=${{ secrets.PUBLIC_GITHUB_TOKEN }}" | ||
| tags: | | ||
| ghcr.io/${{ github.repository_owner }}/studiocms-docs:${{ github.sha }} | ||
| ghcr.io/${{ github.repository_owner }}/studiocms-docs:pr-${{ github.event.pull_request.number }} | ||
| cache-from: type=registry,ref=ghcr.io/${{ github.repository_owner }}/studiocms-docs-pr:cache | ||
| cache-to: type=inline | ||
|
|
||
| - name: Verify pushed image | ||
| run: | | ||
| echo "Pushed: ghcr.io/${{ github.repository_owner }}/studiocms-docs:${{ github.sha }}" | ||
| echo "Pushed: ghcr.io/${{ github.repository_owner }}/studiocms-docs:pr-${{ github.event.pull_request.number }}" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| FROM node:lts AS build | ||
| RUN --mount=type=secret,id=public_github_token export PUBLIC_GITHUB_TOKEN=$(cat /run/secrets/public_github_token) && echo "Secret loaded" | ||
|
|
||
| WORKDIR /app | ||
| COPY . . | ||
|
|
||
| RUN npm install --global corepack@latest | ||
| RUN corepack enable pnpm | ||
|
|
||
| RUN pnpm install --frozen-lockfile | ||
| RUN pnpm run build | ||
|
|
||
| FROM nginx:alpine AS runtime | ||
| COPY ./nginx.conf /etc/nginx/nginx.conf | ||
| COPY --from=build /app/dist /usr/share/nginx/html | ||
| EXPOSE 8080 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.