From 05998f425a2a57d4a0231ea92dd815b2d3f7da09 Mon Sep 17 00:00:00 2001 From: Claudia Date: Thu, 6 Feb 2025 11:11:55 +0100 Subject: [PATCH 1/3] dummy change --- CONTRIBUTION_GUIDE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTION_GUIDE.md b/CONTRIBUTION_GUIDE.md index 8770f5531..b3ada4028 100644 --- a/CONTRIBUTION_GUIDE.md +++ b/CONTRIBUTION_GUIDE.md @@ -2,6 +2,8 @@ --- +lala + Thank you for being interested in contributing to Aragon! 🎉  We’re excited to have you building this vision with us. There are many ways to contribute! Some ideas are: From 89c3799c0fbf8642fde64f5a2e9fd9f45517ecc9 Mon Sep 17 00:00:00 2001 From: Claudia Date: Thu, 6 Feb 2025 11:15:16 +0100 Subject: [PATCH 2/3] feat: remove documentation related workflow --- .github/workflows/documentation-update.yml | 68 ------------------- .../subgraph-documentation-update.yml | 65 ------------------ 2 files changed, 133 deletions(-) delete mode 100644 .github/workflows/documentation-update.yml delete mode 100644 .github/workflows/subgraph-documentation-update.yml diff --git a/.github/workflows/documentation-update.yml b/.github/workflows/documentation-update.yml deleted file mode 100644 index 26c44386c..000000000 --- a/.github/workflows/documentation-update.yml +++ /dev/null @@ -1,68 +0,0 @@ -name: Documentation Update - -on: - workflow_call: - push: - branches: - - develop - -jobs: - update_docs: - permissions: read-all - runs-on: ubuntu-latest - env: - ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }} - steps: - - name: Checkout code - uses: actions/checkout@v4 - - name: Setup nodejs - uses: actions/setup-node@v4 - with: - cache: 'yarn' - node-version: 18 - - name: Install dependencies - run: yarn install --frozen-lockfile - - name: Clean the contracts directory - run: yarn clean - working-directory: packages/contracts/ - - name: Generate docs - run: yarn run docgen - working-directory: packages/contracts/ - - name: Remove the plugins & token contracts docs - run: rm -rf plugins token - working-directory: packages/contracts/docs/developer-portal/03-reference-guide/ - - name: Remove Framework Lifecycle docs - run: rm -rf 04-framework-lifecycle - working-directory: packages/contracts/docs/developer-portal/ - - name: Format with prettier - run: yarn run prettier 'packages/contracts/docs/developer-portal/03-reference-guide/**/*.md' --write - - name: Checkout developer-portal - uses: actions/checkout@v4 - with: - repository: aragon/developer-portal - ref: staging - path: developer-portal - token: ${{ secrets.ARABOT_PAT }} - - name: Remove the docs/osx/03-reference-guide folder in the developer-portal, excluding index.md - run: | - cd $GITHUB_WORKSPACE/developer-portal/docs/osx/03-reference-guide - shopt -s extglob - rm -rf !(index.md) - - name: Copy the docs/developer-portal/03-reference-guide folder to the developer-portal - run: cp -R packages/contracts/docs/developer-portal/03-reference-guide $GITHUB_WORKSPACE/developer-portal/docs/osx/03-reference-guide - - name: Get short commit hash - id: hash - run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT - - name: Create Pull Request - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.ARABOT_PAT }} - path: developer-portal - commit-message: 'Update the Aragon OSx docs by commit ${{ steps.hash.outputs.sha_short }}' - committer: 'Arabot ' - branch: patch/aragon-osx-docs - delete-branch: true - title: Update the Aragon OSx docs - body: 'Automated update by Github actions (Run: [${{ github.run_id }}](https://github.com/aragon/osx/actions/runs/${{ github.run_id }}))' - reviewers: ${{ github.actor }} - team-reviewers: Ara-Team-OSX diff --git a/.github/workflows/subgraph-documentation-update.yml b/.github/workflows/subgraph-documentation-update.yml deleted file mode 100644 index 21e8efd58..000000000 --- a/.github/workflows/subgraph-documentation-update.yml +++ /dev/null @@ -1,65 +0,0 @@ -# This workflow is triggered when a pull request is closed on the 'develop' or 'main' branches -# and there is a change to the 'packages/subgraph/schema.graphql' file. - -name: Subgraph Documentation Update - -on: - workflow_dispatch: - workflow_call: - push: - branches: - - develop - paths: - - 'packages/subgraph/schema.graphql' - - 'packages/subgraph/src/examples/**' - - '.github/workflows/subgraph-deploy.yaml' - -jobs: - update_subgraph_docs: - permissions: read-all - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v4 - - name: Setup nodejs - uses: actions/setup-node@v4 - with: - cache: 'yarn' - node-version: 18 - - name: Install dependencies - run: yarn install --frozen-lockfile - - name: Generate partial introspection query results for documentation - run: yarn generate:introspection:partial - working-directory: packages/subgraph/ - - name: Generate Query Examples docs - run: yarn docs:examples - working-directory: packages/subgraph/ - - name: Checkout developer-portal - uses: actions/checkout@v4 - with: - repository: aragon/developer-portal - ref: staging - path: developer-portal - token: ${{ secrets.ARABOT_PAT }} - - name: Remove the docs/subgraph folder in the developer-portal - run: rm -rf $GITHUB_WORKSPACE/developer-portal/versioned_docs/version-1.3.0/osx/subgraph - - name: Copy the docs/developer-portal folder to the developer-portal - run: cp -R packages/subgraph/docs/developer-portal $GITHUB_WORKSPACE/developer-portal/versioned_docs/version-1.3.0/osx/subgraph - - name: Copy the generated schema-introspection-partial.json to the developer-portal - run: cp -R packages/subgraph/docs/schema-introspection-partial.json $GITHUB_WORKSPACE/developer-portal/static/subgraph - - name: Get short commit hash - id: hash - run: echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT - - name: Create Pull Request - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.ARABOT_PAT }} - path: developer-portal - commit-message: 'Update the Aragon Subgraph docs by commit ${{ steps.hash.outputs.sha_short }}' - committer: 'Arabot ' - branch: patch/aragon-subgraph-docs - delete-branch: true - title: Update the Aragon Subgraph docs - body: 'Automated update by Github actions (Run: [${{ github.run_id }}](https://github.com/aragon/osx/actions/runs/${{ github.run_id }}))' - reviewers: ${{ github.actor }} - team-reviewers: Ara-Team-OSX From d35ace54c2684694403017f8560a2f737069ac50 Mon Sep 17 00:00:00 2001 From: Claudia Date: Thu, 6 Feb 2025 11:27:40 +0100 Subject: [PATCH 3/3] undo --- CONTRIBUTION_GUIDE.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTION_GUIDE.md b/CONTRIBUTION_GUIDE.md index b3ada4028..8770f5531 100644 --- a/CONTRIBUTION_GUIDE.md +++ b/CONTRIBUTION_GUIDE.md @@ -2,8 +2,6 @@ --- -lala - Thank you for being interested in contributing to Aragon! 🎉  We’re excited to have you building this vision with us. There are many ways to contribute! Some ideas are: