diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 39cff0e929..f67bb0292b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -110,6 +110,23 @@ jobs: with: ref: main path: contrast-main + - uses: ./contrast-working/.github/actions/setup_nix + with: + githubToken: ${{ secrets.GITHUB_TOKEN }} + cachixToken: ${{ secrets.CACHIX_AUTH_TOKEN }} + - name: Configure git + run: | + git config --global user.name "edgelessci" + git config --global user.email "edgelessci@users.noreply.github.com" + - name: Create docs release + working-directory: contrast-main/docs + run: | + nix run .#yarn install + nix run .#yarn docusaurus docs:version ${{ needs.process-inputs.outputs.WITHOUT_V }} + git add . + git commit -am "docs: release ${{ needs.process-inputs.outputs.WITHOUT_V }}" + # Clean up auxiliary files, so next steps run on a clean tree + git clean -fx :/ - name: Bump flake version to post release patch pre-version id: bump uses: ./contrast-working/.github/actions/bump_version # Run action from working branch! @@ -127,6 +144,7 @@ jobs: commit-message: ${{ steps.bump.outputs.commit-msg }} base: main draft: false + labels: "no changelog" branch: automated/update-main-after-${{ needs.process-inputs.outputs.WORKING_BRANCH }} committer: edgelessci author: edgelessci diff --git a/docs/README.md b/docs/README.md index e68f10f6a0..60d2d13f67 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Contrast Documentation -## Previewing +## Previewing changes locally The Contrast flake contains a development shell for working on the documentation. @@ -19,20 +19,13 @@ yarn start Browse to and choose the "Next" version in the top right. -## Publish process +## CI integration -The docs are updated with [publish-docs](../.github/workflows/publish-docs.yml) when pushed on main. +- **PR preview** Created by [`docs_publish`](../.github/workflows/docs_publish.yml) on PR. + This will build the website and push it to the [`/pr-preview` directory](https://github.com/edgelesssys/contrast/tree/gh-pages/pr-preview)of the `gh-pages` branch. +- **Publishing** Deployed by [`docs_publish`](../.github/workflows/docs_publish.yml) on push to main. + This will build the website and push it to the [`gh-pages` branch](https://github.com/edgelesssys/contrast/tree/gh-pages). +- **Actual deployment** happens through a [GitHub controlled action](https://github.com/edgelesssys/contrast/actions/workflows/pages/pages-build-deployment). +- **Release versioning** happens as part of the [release workflow](../.github/workflows/release.yml) -## Release process - -1. [Tagging a new version](https://docusaurus.io/docs/next/versioning#tagging-a-new-version) - - ```shell - npm run docusaurus docs:version X.X - ``` - - When tagging a new version, the document versioning mechanism will: - - Copy the full `docs/docs/` folder contents into a new `docs/versioned_docs/version-[versionName]/` folder. - Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as `docs/versioned_sidebars/version-[versionName]-sidebars.json`. - Append the new version number to `versions.json`. +Check out the [latest deployments](https://github.com/edgelesssys/contrast/deployments) (both main and PR preview). diff --git a/docs/docs/_media/contrast_icon.svg b/docs/docs/_media/contrast_icon.svg deleted file mode 100755 index 235ee27474..0000000000 --- a/docs/docs/_media/contrast_icon.svg +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/docs/static/img/emoijvoto.png b/docs/docs/_media/emoijvoto.png similarity index 100% rename from docs/static/img/emoijvoto.png rename to docs/docs/_media/emoijvoto.png diff --git a/docs/docs/examples/emojivoto.md b/docs/docs/examples/emojivoto.md index ca815f49f8..db25b17f9a 100644 --- a/docs/docs/examples/emojivoto.md +++ b/docs/docs/examples/emojivoto.md @@ -1,7 +1,7 @@ # Confidential emoji voting -![screenshot of the emojivoto UI](../../static/img/emoijvoto.png) +![screenshot of the emojivoto UI](../_media/emoijvoto.png) **This tutorial guides you through deploying [emojivoto](https://github.com/BuoyantIO/emojivoto) as a confidential Contrast deployment and validating the deployment from a voters perspective.** diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index e1ad9a380a..a296d1491b 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -105,7 +105,7 @@ async function createConfig() { items: [ { label: 'Newsletter', - href: 'https://www.edgeless.systems/#footer' + href: 'https://www.edgeless.systems/#footer-id' }, ], }, @@ -124,7 +124,6 @@ async function createConfig() { label: 'LinkedIn', href: 'https://www.linkedin.com/company/edgeless-systems/', }, - { label: 'Youtube', href: 'https://www.youtube.com/channel/UCOOInN0sCv6icUesisYIDeA', @@ -145,7 +144,6 @@ async function createConfig() { { html: `Cookie Settings` }, - { label: 'Contact Us', href: 'https://www.edgeless.systems/contact-us/',