Skip to content

Commit

Permalink
Merge branch 'develop' into tooling-sdk/cleanup-envs
Browse files Browse the repository at this point in the history
  • Loading branch information
@begonaalvarezd
begonaalvarezd authored Nov 5, 2024
2 parents 731d3fd + 4e8f353 commit 666184c
Show file tree
Hide file tree
Showing 6 changed files with 619 additions and 469 deletions.
32 changes: 16 additions & 16 deletions .github/workflows/release_docker.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@ jobs:
type=raw,value={{sha}},enable=${{ github.event_name == 'workflow_dispatch' }}
type=raw,value=latest,enable=${{ github.event_name == 'workflow_dispatch' }}
type=raw,value={{tag}},enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-alpha.*\d*,group=0,value=alphanet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-beta.*\d*,group=0,value=devnet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-rc.*\d*,group=0,value=testnet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+$,group=0,value=mainnet,enable=${{ github.event_name == 'release' }}
type=raw,value=alphanet,enable=${{ github.event_name == 'release' && contains(github.ref, '-alpha') }}
type=raw,value=devnet,enable=${{ github.event_name == 'release' && contains(github.ref, '-beta') }}
type=raw,value=testnet,enable=${{ github.event_name == 'release' && contains(github.ref, '-rc') }}
type=raw,value=mainnet,enable=${{ github.event_name == 'release' && !contains(github.ref, '-alpha') && !contains(github.ref, '-beta') && !contains(github.ref, '-rc') }}
- name: Login to Docker Registry
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # pin@v3
Expand Down Expand Up @@ -114,10 +114,10 @@ jobs:
type=raw,value={{sha}},enable=${{ github.event_name == 'workflow_dispatch' }}
type=raw,value=latest,enable=${{ github.event_name == 'workflow_dispatch' }}
type=raw,value={{tag}},enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-alpha.*\d*,group=0,value=alphanet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-beta.*\d*,group=0,value=devnet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-rc.*\d*,group=0,value=testnet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+$,group=0,value=mainnet,enable=${{ github.event_name == 'release' }}
type=raw,value=alphanet,enable=${{ github.event_name == 'release' && contains(github.ref, '-alpha') }}
type=raw,value=devnet,enable=${{ github.event_name == 'release' && contains(github.ref, '-beta') }}
type=raw,value=testnet,enable=${{ github.event_name == 'release' && contains(github.ref, '-rc') }}
type=raw,value=mainnet,enable=${{ github.event_name == 'release' && !contains(github.ref, '-alpha') && !contains(github.ref, '-beta') && !contains(github.ref, '-rc') }}
- name: Login to Docker Registry
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # pin@v3
Expand Down Expand Up @@ -173,10 +173,10 @@ jobs:
type=raw,value={{sha}},enable=${{ github.event_name == 'workflow_dispatch' }}
type=raw,value=latest,enable=${{ github.event_name == 'workflow_dispatch' }}
type=raw,value={{tag}},enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-alpha.*\d*,group=0,value=alphanet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-beta.*\d*,group=0,value=devnet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-rc.*\d*,group=0,value=testnet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+$,group=0,value=mainnet,enable=${{ github.event_name == 'release' }}
type=raw,value=alphanet,enable=${{ github.event_name == 'release' && contains(github.ref, '-alpha') }}
type=raw,value=devnet,enable=${{ github.event_name == 'release' && contains(github.ref, '-beta') }}
type=raw,value=testnet,enable=${{ github.event_name == 'release' && contains(github.ref, '-rc') }}
type=raw,value=mainnet,enable=${{ github.event_name == 'release' && !contains(github.ref, '-alpha') && !contains(github.ref, '-beta') && !contains(github.ref, '-rc') }}
- name: Login to Docker Registry
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # pin@v3
Expand Down Expand Up @@ -232,10 +232,10 @@ jobs:
type=raw,value={{sha}},enable=${{ github.event_name == 'workflow_dispatch' }}
type=raw,value=latest,enable=${{ github.event_name == 'workflow_dispatch' }}
type=raw,value={{tag}},enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-alpha.*\d*,group=0,value=alphanet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-beta.*\d*,group=0,value=devnet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+-rc.*\d*,group=0,value=testnet,enable=${{ github.event_name == 'release' }}
type=match,pattern=v\d+\.\d+\.\d+$,group=0,value=mainnet,enable=${{ github.event_name == 'release' }}
type=raw,value=alphanet,enable=${{ github.event_name == 'release' && contains(github.ref, '-alpha') }}
type=raw,value=devnet,enable=${{ github.event_name == 'release' && contains(github.ref, '-beta') }}
type=raw,value=testnet,enable=${{ github.event_name == 'release' && contains(github.ref, '-rc') }}
type=raw,value=mainnet,enable=${{ github.event_name == 'release' && !contains(github.ref, '-alpha') && !contains(github.ref, '-beta') && !contains(github.ref, '-rc') }}
- name: Login to Docker Registry
uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # pin@v3
Expand Down
1 change: 1 addition & 0 deletions docs/content/references/.gitignore
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
iota-api/iota-graphql/*
framework/**
ts-sdk/api/**
11 changes: 11 additions & 0 deletions docs/content/sidebars/references.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Modifications Copyright (c) 2024 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

import typedocSidebar from '../references/ts-sdk/api/typedoc-sidebar.cjs';
const references = [
{
type: 'doc',
Expand Down Expand Up @@ -188,6 +189,16 @@ const references = [
],
},
'references/ts-sdk/bcs',
{
type: 'category',
label: 'API',
link:{
type: 'doc',
id: 'references/ts-sdk/api/index',
},
items: typedocSidebar,
},

],
},
],
Expand Down
36 changes: 35 additions & 1 deletion docs/site/docusaurus.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,38 @@ const config = {
};
},
path.resolve(__dirname, `./src/plugins/descriptions`),
[
'docusaurus-plugin-typedoc',
// Options
{
tsconfig: '../../sdk/typescript/tsconfig.json',
entryPoints: [
"../../sdk/typescript/src/bcs",
"../../sdk/typescript/src/client",
"../../sdk/typescript/src/cryptography",
"../../sdk/typescript/src/faucet",
"../../sdk/typescript/src/graphql",
"../../sdk/typescript/src/keypairs/ed25519",
"../../sdk/typescript/src/keypairs/secp256k1",
"../../sdk/typescript/src/keypairs/secp256k1",
"../../sdk/typescript/src/multisig",
"../../sdk/typescript/src/transactions",
"../../sdk/typescript/src/utils",
"../../sdk/typescript/src/verify"
],
plugin: ["typedoc-plugin-markdown"],
out: "../../docs/content/references/ts-sdk/api/",
githubPages: false,
readme: "none",
hideGenerator: true,
sort: ["source-order"],
excludeInternal: true,
excludePrivate: true,
disableSources: true,
hideBreadcrumbs: true,
intentionallyNotExported: [],
},
],
],
presets: [
[
Expand All @@ -93,7 +125,9 @@ const config = {
}) {
return defaultSidebarItemsGenerator({
...args,
isCategoryIndex() {
isCategoryIndex(doc) {
if(doc.fileName === 'index' && doc.directories.includes('ts-sdk'))
return true;
// No doc will be automatically picked as category index
return false;
},
Expand Down
3 changes: 3 additions & 0 deletions docs/site/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,10 @@
"@docusaurus/types": "3.5.2",
"@metamask/providers": "^10.2.1",
"@types/react": "^18.3.3",
"docusaurus-plugin-typedoc": "^1.0.5",
"remark-code-import": "^1.2.0",
"typedoc": "^0.26.10",
"typedoc-plugin-markdown": "^4.2.9",
"typescript": "^5.5.3"
},
"resolutions": {
Expand Down
Loading

0 comments on commit 666184c

Please sign in to comment.