From 4fc35c251a54eb4b070c3eec0297d322a20010bc Mon Sep 17 00:00:00 2001 From: Steven Johnson Date: Thu, 9 Nov 2023 17:02:29 +0700 Subject: [PATCH] feat(docs): Make Branch documentation deletion the same as creation. (#133) * refactor(gateway): Rename catalyst-voices-backend to the catalyst-gateway * docs(gateway): Update readme * refactor(gateway): Move the code into the new directory trees, cleanup inside tree still todo. * refactor(gateway): Basic refactor of the event-db config/data and the db interface logic * docs(gateway): Initial docs for the crates directory inside catalyst gateway * refactor(gateway): Move code out of cat-data-service and put it directly in bin * feat(gateway): first build seems to work, but fails due to WIP refactor * refactor(gateway): Refactor builds properly to a static executable. * refactor(gateway): autofixed lints * refactor(gateway): WIP remove lint errors * refactor(gateway): WIP refactoring work to remove lint errors * refactor(gateway): Don't panic, return the error, and generalize the error itself. * refactor(gateway): generalize error response * docs(gateway): indexing ok here, slice already checked to have values * refactor(gateway): Indexing is safe here, so note it. * refactor(gateway): don't panic, return an error. reduce size of function by splitting into multiple logical units. * refactor(gateway): Purge metrics from legacy service. Unused and can panic. * refactor(gateway): remove unused rust files from EventDB directory * refactor(gateway): remove unused dependencies * docs(gateway): Allow intentional panic for test code * refactor(gateway): eliminate or notate why unwraps/expect are safe * refactor(gateway): All lints are clean and restrictively applied * refactor(gateway): remove unused dependencies from workspace cargo file * refactor(gateway): restrict visibility of event_db to pub(crate) as its fully internalized now. * docs(gateway): root level fully documented * docs(gateway): state fully documented * docs(gateway): Don't worry about full docs for legacy service. * docs(gateway): Service top level fully documented * docs(gateway): middleware docs complete * docs(gateway): Fully documented the docs part of the service * docs(gateway): common responses and module root fully documented * docs(gateway): Common objects now fully documented * docs(gateway): Api endpoint docs are complete * docs(gateway): DB Types fully documented * docs(gateway): Queries partially documented * docs(gateway): Everything that needs docs is documented * feat(gateway): Initial CI and Cat-Gateway build ready for PR * feat(rust): Add recommended rust extensions for vscode, and rust settings. * docs(gateway): Fix spelling * ci(gateway): Use the proper versioned CI tooling from catalyst-ci * feat(docs): Docs WIP setup * docs(docs): Fix the docs so they use the latests docs-ci and are able to properly include data from build targets * docs(docs): fix spelling and markdown lint issues * docs(docs): Update to use latest Cat-CI Docs and reduce replication * docs(docs): Fix the top level parts of the docs and remove test values * docs(docs): try and build and deploy docs to gh-pages * docs(docs): fix spelling issue * docs(docs): Use proper docs action, and also add branch cleanup for branch docs * docs(docs): Use the published versions from Catalyst-CI * docs(docs): Ensure we do not try and clean docs while building them. * docs(docs): Ensure we don't try and build docs simultaneously, Don't build docs for tags. * ci(mdlint): Use tagged CI versions for stability * ci(spelling): Use tagged CI versions for stability * docs(docs): Edit docs so we test deployment * fix(docs): Try and force docs to build for all branches, but not for any tags * fix(docs): Revert docs to build on any push and see if they start building again. * fix(docs): Use latest workflow from catalyst-ci for docs * fix(docs): Docs should build for any branch but never for a tag. * fix(docs): Need double quotes for branches to work properly * docs(docs): Add a small doc change * ci(docs): Make branch doc deletion like branch doc creation. * docs(docs): fix spelling issues --- .github/workflows/branch-delete-cleanup.yml | 29 +++++++++++++++++---- docs/src/catalyst-standards/index.md | 2 ++ 2 files changed, 26 insertions(+), 5 deletions(-) diff --git a/.github/workflows/branch-delete-cleanup.yml b/.github/workflows/branch-delete-cleanup.yml index 486849acc33..6d148d623fb 100644 --- a/.github/workflows/branch-delete-cleanup.yml +++ b/.github/workflows/branch-delete-cleanup.yml @@ -1,13 +1,32 @@ name: Branch Deleted -on: delete +# cspell: words earthfile + +on: + delete: + branches: + - "**" + tags-ignore: + - "**" concurrency: group: "docs" cancel-in-progress: false +permissions: + id-token: write + contents: write + packages: write + jobs: - delete: - name: On branch deleted - if: github.event.ref_type == 'branch' - uses: input-output-hk/catalyst-ci/.github/workflows/branch-delete-cleanup.yml@v2.0.6 + ci: + uses: input-output-hk/catalyst-ci/.github/workflows/branch-pages-delete.yml@master + with: + aws_role_arn: arn:aws:iam::332405224602:role/ci + aws_region: eu-central-1 + ci_cli_version: 1.3.1 + earthfile: ./docs + target: docs + secrets: + earthly_runner_address: ${{ secrets.EARTHLY_SATELLITE_ADDRESS }} + earthly_runner_secret: ${{ secrets.EARTHLY_RUNNER_SECRET }} diff --git a/docs/src/catalyst-standards/index.md b/docs/src/catalyst-standards/index.md index 8cd5a72972c..3e1970666cf 100644 --- a/docs/src/catalyst-standards/index.md +++ b/docs/src/catalyst-standards/index.md @@ -4,3 +4,5 @@ icon: material/pillar # Catalyst Standards + +These are documents that relate to standardized specifications of the catalyst stack.