diff --git a/.github/actions/docs-spelling/excludes.txt b/.github/actions/docs-spelling/excludes.txt index 71956a14c9..8888de71fc 100644 --- a/.github/actions/docs-spelling/excludes.txt +++ b/.github/actions/docs-spelling/excludes.txt @@ -72,5 +72,6 @@ ignore$ (?:^|/)yarn\.lock$ (?:^|/)(?i)docusaurus.config.js (?:^|/)(?i)README.md +(?:^|/)(?i).nojekyll ^\static/ \.tsx$ diff --git a/.github/workflows/docs-release.yml b/.github/workflows/docs-release.yml new file mode 100644 index 0000000000..1ec6405414 --- /dev/null +++ b/.github/workflows/docs-release.yml @@ -0,0 +1,30 @@ +name: Release Docs to Github Pages + +# Release docs on every push to master +on: + push: + branches: + - master + paths: + - "packages/docs/**" + - ".github/workflows/docs-spelling.yml" + - ".github/actions/docs-spelling/**" + workflow_dispatch: + +jobs: + deploy: + runs-on: ubuntu-latest + name: Deploy Docs + steps: + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + + - name: Set up environment + uses: ./.github/actions/setup + + - name: Docusaurus Deploy + run: | + GIT_USER=MikesGlitch \ + GIT_PASS=${{ secrets.DOCS_GITHUB_PAGES_DEPLOY }} \ + GIT_USER_NAME=github-actions[bot] \ + GIT_USER_EMAIL=github-actions[bot]@users.noreply.github.com \ + yarn deploy:docs diff --git a/package.json b/package.json index 1e546ac079..d989f615dd 100644 --- a/package.json +++ b/package.json @@ -40,6 +40,7 @@ "build:plugins-service": "yarn workspace plugins-service build", "build:api": "yarn workspace @actual-app/api build", "build:docs": "yarn workspace docs build", + "deploy:docs": "yarn workspace docs deploy", "generate:i18n": "yarn workspace @actual-app/web generate:i18n", "generate:release-notes": "ts-node ./bin/release-note-generator.ts", "test": "lage test --continue", diff --git a/packages/docs/docusaurus.config.js b/packages/docs/docusaurus.config.js index 14d72bc01f..38ea283d0b 100644 --- a/packages/docs/docusaurus.config.js +++ b/packages/docs/docusaurus.config.js @@ -17,6 +17,10 @@ module.exports = { onBrokenLinks: 'throw', favicon: 'img/favicon.ico', + projectName: 'actualbudget.github.io', + organizationName: 'actualbudget', + deploymentBranch: 'main', + // Even if you don't use internalization, you can use this field to set useful // metadata like html lang. For example, if your site is Chinese, you may want // to replace "en" with "zh-Hans". diff --git a/packages/docs/static/.nojekyll b/packages/docs/static/.nojekyll new file mode 100644 index 0000000000..e69de29bb2 diff --git a/upcoming-release-notes/6386.md b/upcoming-release-notes/6386.md new file mode 100644 index 0000000000..022c502f20 --- /dev/null +++ b/upcoming-release-notes/6386.md @@ -0,0 +1,7 @@ +--- +category: Maintenance +authors: [MikesGlitch] +--- + +Workflow and config added for docs site move to Github Pages +