Skip to content

Commit 8401669

Browse files
DominikkqDominikkq
authored
feat: DevX Automated Documentation | Flyover-2.2.0 (#700)
* feat: devx automated documentation * fix: rename main -> master * fix: rename devportal workflow file * fix: remove score-cards * fix: feedback * fix: add badges
1 parent fae467f commit 8401669

File tree

10 files changed

+756
-255
lines changed

10 files changed

+756
-255
lines changed

‎.github/workflows/devPortal-update.yml‎

Lines changed: 236 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
name: Update Devportal Documentation (Flyover LPS)
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- '*.md'
8+
- 'docs/**/*.md'
9+
10+
permissions: read-all
11+
12+
jobs:
13+
update-docs:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout Code
17+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
18+
19+
# Step 1: Clone the Devportal Repository
20+
- name: Clone Devportal Repository
21+
env:
22+
GITHUB_TOKEN: ${{ secrets.DEVPORTAL_DOCS_UPDATE_TOKEN }}
23+
run: |
24+
TIMESTAMP=$(date +'%Y%m%d-%H%M%S')
25+
BRANCH_NAME="update-from-lps-${TIMESTAMP}"
26+
echo "BRANCH_NAME=${BRANCH_NAME}" >> $GITHUB_ENV
27+
28+
git clone https://github.com/rsksmart/devportal.git
29+
cd devportal
30+
git checkout -b ${BRANCH_NAME} || git checkout ${BRANCH_NAME}
31+
cd ..
32+
33+
# Step 2: Transform Each File and Copy to Devportal Repository
34+
- name: Transform Files for Devportal
35+
run: |
36+
set -e
37+
mkdir -p transformed
38+
39+
BASE_SRC="."
40+
BASE_DST="devportal/docs/02-developers/06-integrate/02-flyover"
41+
42+
#####################################
43+
# Usecases #
44+
#####################################
45+
TEMP_FILE="temp_index.md"
46+
tail -n +2 ${BASE_SRC}/docs/Usecases.md > ${TEMP_FILE}
47+
TRANSFORMED_FILE="transformed/index.md"
48+
echo "---" > ${TRANSFORMED_FILE}
49+
echo "sidebar_label: RBTC Flyover" >> ${TRANSFORMED_FILE}
50+
echo "sidebar_position: 100" >> ${TRANSFORMED_FILE}
51+
echo "title: RBTC Flyover - Overview" >> ${TRANSFORMED_FILE}
52+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg]" >> ${TRANSFORMED_FILE}
53+
echo "description: The RBTC Flyover enables fast, trust-minimized onboarding of users into the Rootstock ecosystem from Bitcoin with less friction. It improves the usability for bitcoiners and integrators to interact with the Rootstock ecosystem via the Powpeg and Flyover SDK." >> ${TRANSFORMED_FILE}
54+
echo "---" >> ${TRANSFORMED_FILE}
55+
echo "" >> ${TRANSFORMED_FILE}
56+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
57+
rm ${TEMP_FILE}
58+
cp ${TRANSFORMED_FILE} ${BASE_DST}/index.md
59+
60+
#####################################
61+
# Get Started (README) #
62+
#####################################
63+
TEMP_FILE="temp_get-started.md"
64+
tail -n +1 ${BASE_SRC}/README.md | grep -Ev "OpenSSF Scorecard|CodeQL|Unit Tests" > ${TEMP_FILE}
65+
TRANSFORMED_FILE="transformed/get-started.md"
66+
echo "---" > ${TRANSFORMED_FILE}
67+
echo "sidebar_label: Getting Started" >> ${TRANSFORMED_FILE}
68+
echo "sidebar_position: 210" >> ${TRANSFORMED_FILE}
69+
echo "title: Getting Started as a Liquidity Provider" >> ${TRANSFORMED_FILE}
70+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg]" >> ${TRANSFORMED_FILE}
71+
echo "description: The Flyover SDK streamlines integration between client applications and the Flyover Protocol. This easy-to-use JavaScript/TypeScript toolkit provides configuration options for Liquidity Providers (LPs) and custom network setups for connecting to Rootstock." >> ${TRANSFORMED_FILE}
72+
echo "---" >> ${TRANSFORMED_FILE}
73+
echo "" >> ${TRANSFORMED_FILE}
74+
echo ":::info[Note]" >> ${TRANSFORMED_FILE}
75+
echo "If you wish to suggest changes on this document, please open a PR on the [Liquidity Provider Server Repository](https://github.com/rsksmart/liquidity-provider-server.git)" >> ${TRANSFORMED_FILE}
76+
echo ":::" >> ${TRANSFORMED_FILE}
77+
echo "" >> ${TRANSFORMED_FILE}
78+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
79+
rm ${TEMP_FILE}
80+
mkdir -p ${BASE_DST}/LP
81+
cp ${TRANSFORMED_FILE} ${BASE_DST}/LP/get-started.md
82+
83+
#####################################
84+
# Security #
85+
#####################################
86+
TEMP_FILE="temp_security.md"
87+
tail -n +1 ${BASE_SRC}/SECURITY.md > ${TEMP_FILE}
88+
TRANSFORMED_FILE="transformed/security.md"
89+
echo "---" > ${TRANSFORMED_FILE}
90+
echo "sidebar_label: Security Process" >> ${TRANSFORMED_FILE}
91+
echo "sidebar_position: 230" >> ${TRANSFORMED_FILE}
92+
echo "title: Liquidity Provider Server Security Process" >> ${TRANSFORMED_FILE}
93+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg, security]" >> ${TRANSFORMED_FILE}
94+
echo "description: Learn about the security process for the Liquidity Provider Server in the Flyover protocol, including vulnerability reporting, disclosure policies, and public keys." >> ${TRANSFORMED_FILE}
95+
echo "---" >> ${TRANSFORMED_FILE}
96+
echo "" >> ${TRANSFORMED_FILE}
97+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
98+
rm ${TEMP_FILE}
99+
cp ${TRANSFORMED_FILE} ${BASE_DST}/LP/security.md
100+
101+
#####################################
102+
# Docker Setup #
103+
#####################################
104+
TEMP_FILE="temp_docker-setup.md"
105+
tail -n +2 ${BASE_SRC}/docker-compose/README.md > ${TEMP_FILE}
106+
TRANSFORMED_FILE="transformed/docker-setup.md"
107+
echo "---" > ${TRANSFORMED_FILE}
108+
echo "sidebar_label: Docker Setup" >> ${TRANSFORMED_FILE}
109+
echo "sidebar_position: 230" >> ${TRANSFORMED_FILE}
110+
echo "title: Docker Setup for Liquidity Provider Server" >> ${TRANSFORMED_FILE}
111+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg, docker]" >> ${TRANSFORMED_FILE}
112+
echo "description: Learn how to run a Liquidity Provider Server (LPS) using Docker Compose, including configuration for both regtest and testnet environments." >> ${TRANSFORMED_FILE}
113+
echo "---" >> ${TRANSFORMED_FILE}
114+
echo "" >> ${TRANSFORMED_FILE}
115+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
116+
rm ${TEMP_FILE}
117+
cp ${TRANSFORMED_FILE} ${BASE_DST}/LP/docker-setup.md
118+
119+
#####################################
120+
# Protocol Design #
121+
#####################################
122+
TEMP_FILE="temp_design.md"
123+
tail -n +2 ${BASE_SRC}/docs/DESIGN.md > ${TEMP_FILE}
124+
TRANSFORMED_FILE="transformed/design.md"
125+
echo "---" > ${TRANSFORMED_FILE}
126+
echo "sidebar_label: Protocol Design" >> ${TRANSFORMED_FILE}
127+
echo "sidebar_position: 220" >> ${TRANSFORMED_FILE}
128+
echo "title: Flyover Protocol Design" >> ${TRANSFORMED_FILE}
129+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg]" >> ${TRANSFORMED_FILE}
130+
echo "description: The Flyover protocol allows fast Bitcoin to Rootstock transfers without giving custody of funds to third parties. Learn about the system design and workflow." >> ${TRANSFORMED_FILE}
131+
echo "---" >> ${TRANSFORMED_FILE}
132+
echo "" >> ${TRANSFORMED_FILE}
133+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
134+
rm ${TEMP_FILE}
135+
cp ${TRANSFORMED_FILE} ${BASE_DST}/LP/design.md
136+
137+
#####################################
138+
# Environment Variables #
139+
#####################################
140+
TEMP_FILE="temp_setting-variables.md"
141+
tail -n +2 ${BASE_SRC}/docs/Environment.md > ${TEMP_FILE}
142+
TRANSFORMED_FILE="transformed/setting-variables.md"
143+
echo "---" > ${TRANSFORMED_FILE}
144+
echo "sidebar_label: Environment Variables" >> ${TRANSFORMED_FILE}
145+
echo "sidebar_position: 230" >> ${TRANSFORMED_FILE}
146+
echo "title: Setting Environment Variables" >> ${TRANSFORMED_FILE}
147+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg]" >> ${TRANSFORMED_FILE}
148+
echo "description: This section lists every environment variable used by the Liquidity Provider Server (LPS), including examples, default values and whether each setting is mandatory." >> ${TRANSFORMED_FILE}
149+
echo "---" >> ${TRANSFORMED_FILE}
150+
echo "" >> ${TRANSFORMED_FILE}
151+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
152+
rm ${TEMP_FILE}
153+
cp ${TRANSFORMED_FILE} ${BASE_DST}/LP/setting-variables.md
154+
155+
#####################################
156+
# LP Management #
157+
#####################################
158+
TEMP_FILE="temp_management.md"
159+
tail -n +2 ${BASE_SRC}/docs/LP-Management.md > ${TEMP_FILE}
160+
TRANSFORMED_FILE="transformed/management.md"
161+
echo "---" > ${TRANSFORMED_FILE}
162+
echo "sidebar_label: LP Management" >> ${TRANSFORMED_FILE}
163+
echo "sidebar_position: 220" >> ${TRANSFORMED_FILE}
164+
echo "title: Liquidity Provider (LP) Management" >> ${TRANSFORMED_FILE}
165+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg]" >> ${TRANSFORMED_FILE}
166+
echo "description: Learn how Liquidity Providers can secure, configure and manage their server using the Management UI and API, covering collateral, configuration and wallet operations." >> ${TRANSFORMED_FILE}
167+
echo "---" >> ${TRANSFORMED_FILE}
168+
echo "" >> ${TRANSFORMED_FILE}
169+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
170+
rm ${TEMP_FILE}
171+
cp ${TRANSFORMED_FILE} ${BASE_DST}/LP/management.md
172+
173+
#####################################
174+
# Operating LP #
175+
#####################################
176+
TEMP_FILE="temp_lp-onboarding.md"
177+
tail -n +2 ${BASE_SRC}/docs/Operating-LP.md > ${TEMP_FILE}
178+
TRANSFORMED_FILE="transformed/lp-onboarding.md"
179+
echo "---" > ${TRANSFORMED_FILE}
180+
echo "sidebar_label: Liquidity Provider Onboarding" >> ${TRANSFORMED_FILE}
181+
echo "sidebar_position: 200" >> ${TRANSFORMED_FILE}
182+
echo "title: RBTC Flyover - LP Onboarding" >> ${TRANSFORMED_FILE}
183+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg]" >> ${TRANSFORMED_FILE}
184+
echo "description: Step-by-step operational guide outlining requirements, dependencies, fees, liquidity needs and best practices for running a Liquidity Provider Server." >> ${TRANSFORMED_FILE}
185+
echo "---" >> ${TRANSFORMED_FILE}
186+
echo "" >> ${TRANSFORMED_FILE}
187+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
188+
rm ${TEMP_FILE}
189+
cp ${TRANSFORMED_FILE} ${BASE_DST}/LP/index.md
190+
191+
#####################################
192+
# Advanced Operations #
193+
#####################################
194+
TEMP_FILE="temp_advanced-operations.md"
195+
tail -n +2 ${BASE_SRC}/docs/Advanced-Operations.md > ${TEMP_FILE}
196+
TRANSFORMED_FILE="transformed/advanced-operations.md"
197+
echo "---" > ${TRANSFORMED_FILE}
198+
echo "sidebar_label: Advanced Operations" >> ${TRANSFORMED_FILE}
199+
echo "sidebar_position: 240" >> ${TRANSFORMED_FILE}
200+
echo "title: Flyover SDK - Advanced Operations" >> ${TRANSFORMED_FILE}
201+
echo "tags: [rsk, rootstock, rif, flyover, integrate, integration guide, rbtc, powpeg]" >> ${TRANSFORMED_FILE}
202+
echo "description: Advanced topics covering custom network setups, captcha token handling and Flyover SDK utility helpers for sophisticated client integrations." >> ${TRANSFORMED_FILE}
203+
echo "---" >> ${TRANSFORMED_FILE}
204+
echo "" >> ${TRANSFORMED_FILE}
205+
echo ":::info[Note]" >> ${TRANSFORMED_FILE}
206+
echo "If you wish to suggest changes on this document, please open a PR on the [Liquidity Provider Server Repository](https://github.com/rsksmart/liquidity-provider-server.git)" >> ${TRANSFORMED_FILE}
207+
echo ":::" >> ${TRANSFORMED_FILE}
208+
echo "" >> ${TRANSFORMED_FILE}
209+
cat ${TEMP_FILE} >> ${TRANSFORMED_FILE}
210+
rm ${TEMP_FILE}
211+
cp ${TRANSFORMED_FILE} ${BASE_DST}/advanced-operations.md
212+
213+
# Step 3: Commit and Push Changes to Devportal Repository
214+
- name: Commit and Push Changes
215+
env:
216+
GITHUB_TOKEN: ${{ secrets.DEVPORTAL_DOCS_UPDATE_TOKEN }}
217+
run: |
218+
cd devportal
219+
git config user.name "github-actions[bot]"
220+
git config user.email "github-actions[bot]@users.noreply.github.com"
221+
git add docs/02-developers/06-integrate/02-flyover/
222+
git commit -m "Automated update from Liquidity Provider Server repository"
223+
git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/rsksmart/devportal.git
224+
git push -f origin ${BRANCH_NAME}
225+
226+
# Step 4: Create a Pull Request in the Devportal Repository
227+
- name: Create Pull Request
228+
env:
229+
GITHUB_TOKEN: ${{ secrets.DEVPORTAL_DOCS_UPDATE_TOKEN }}
230+
run: |
231+
cd devportal
232+
curl -L -X POST -H "Accept: application/vnd.github+json" \
233+
-H "Authorization: Bearer ${{ secrets.DEVPORTAL_DOCS_UPDATE_TOKEN }}" \
234+
-H "X-GitHub-Api-Version: 2022-11-28" \
235+
https://api.github.com/repos/rsksmart/devportal/pulls \
236+
-d "{\"title\":\"Liquidity-provider-server automated update of documentation ${BRANCH_NAME}\",\"body\":\"This PR updates the Devportal documentation with the latest changes from the Liquidity Provider Server repository.\",\"head\":\"${BRANCH_NAME}\",\"base\":\"main\"}"

0 commit comments

Comments
 (0)