build content docs - in gitlab #1619

kobymeir · 2024-09-05T06:59:21Z

Status

In Progress

Related Issues

fixes: link to the issue

Description

gitlab CI build for docs

xsoar-bot · 2024-09-05T14:17:50Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-fd4eqqij.web.app

Important: Make sure to inspect your changes at the preview site.

xsoar-bot · 2024-09-08T07:12:47Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-fd4eqqij.web.app

Important: Make sure to inspect your changes at the preview site.

xsoar-bot · 2024-09-09T17:30:57Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-fd4eqqij.web.app

Important: Make sure to inspect your changes at the preview site.

stale · 2024-10-05T18:46:08Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs.

If you'd like to keep it open, please leave a comment with the status of the PR.

Thank you for your contribution!

xsoar-bot · 2024-10-06T06:28:21Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-l8pmvv7q.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-10-22T16:57:34Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-10-27T13:51:52Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-10-27T19:00:05Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-10-27T19:06:27Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-11-03T13:18:52Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-11-03T14:46:31Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-11-04T10:35:43Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-11-07T08:35:55Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-11-07T12:19:29Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

content-bot · 2024-11-10T15:45:32Z

Preview Site Available

Congratulations! The automatic build has completed successfully.
A preview site is available at: https://xsoar-pan-dev--pull-request-1619-a3r3zyp5.web.app

Important: Make sure to inspect your changes at the preview site.

tkatzir

Very nice!
Approved, with comments.

tkatzir · 2024-11-10T17:05:48Z

.gitignore

+index.json
+/.firebase/hosting.YnVpbGQ.cache


What's this YnVpbGQ magic value?

tkatzir · 2024-11-10T17:06:35Z

.gitlab/helper_functions.sh

+#!/bin/bash
+
+CYAN="\e[0;36m"
+CLEAR="\e[0m"


I would put CLEAR at the start or the end of this list.

Couldn't be in the end since we use it in line 5

tkatzir · 2024-11-10T17:08:48Z

.gitlab/helper_functions.sh

+        echo "    1. section_start \"<section-start-id>\" \"<section-header>\""
+        echo "    2. section_start \"<section-header>\""
+        echo "    3. section_start \"<section-start-id>\" \"<section-header>\" --collapse"
+        echo "    4. section_start \"<section-header>\" --collapse"


Suggest to group by functionality

Suggested change

echo " 1. section_start \"<section-start-id>\" \"<section-header>\""

echo " 2. section_start \"<section-header>\""

echo " 3. section_start \"<section-start-id>\" \"<section-header>\" --collapse"

echo " 4. section_start \"<section-header>\" --collapse"

echo " 2. section_start \"<section-header>\""

echo " 4. section_start \"<section-header>\" --collapse"

echo " 1. section_start \"<section-start-id>\" \"<section-header>\""

echo " 3. section_start \"<section-start-id>\" \"<section-header>\" --collapse"

tkatzir · 2024-11-10T17:10:05Z

.gitlab/helper_functions.sh

+    start_time=$(date +%s)
+    start="$(echo "$start" | sed -e "s/the_time/$start_time/" -e "s/section_id/$section_id/" -e "s/section_header/$section_header/")"
+    echo -e "$start"
+    date +"[%Y-%m-%dT%H:%M:%S.%3N] section start"


[%Y-%m-%dT%H:%M:%S.%3N] is candidate for a CONST?
Used more than once...

tkatzir · 2024-11-10T17:10:30Z

.gitlab/helper_functions.sh

+        section_header="$2"
+        section_id="$1"
+    else
+        echo "section_start should be called with 1-3 args but it was called with $#"


Suggested change

echo "section_start should be called with 1-3 args but it was called with $#"

echo "section_start should be called with 1-3 args but it was called with $# args"

tkatzir · 2024-11-10T17:26:25Z

content-repo/create-docs.sh

+#echo "Installing pipenv..."
+#pipenv install


Still needed?

tkatzir · 2024-11-10T17:26:49Z

content-repo/create-docs.sh

 echo "Generating docs..."
-pipenv run ./gendocs.py -t "${TARGET_DIR}" -d "${CONTENT_GIT_DIR}" -b "${CURRENT_BRANCH}"
+#pipenv run ./gendocs.py -t "${TARGET_DIR}" -d "${CONTENT_GIT_DIR}" -b "${CURRENT_BRANCH}"


Still needed?

tkatzir · 2024-11-10T17:26:58Z

content-repo/create-docs.sh

 echo "Generating Demisto class and CommonServerPython docs..."
-pipenv run ./gen_pydocs.py -t "${TARGET_DIR}"
+#pipenv run ./gen_pydocs.py -t "${TARGET_DIR}"


Still needed?

tkatzir · 2024-11-10T17:27:46Z

content-repo/create-docs.sh

 if [[ "$CURRENT_BRANCH" != "master" && "$CURRENT_BRANCH" != *"gen-top-contrib"* ]]; then
    echo "Skipping top contributors page generation, should run only on master or branch containing 'gen-top-contrib'."
    exit 0
 else
    echo "Generating top contributors page..."
-    pipenv run python ./gen_top_contrib.py -t "${CONTRIB_TARGET_DIR}"
+    poetry run ./gen_top_contrib.py -t "${CONTRIB_TARGET_DIR}"
+#    pipenv run python ./gen_top_contrib.py -t "${CONTRIB_TARGET_DIR}"


Still needed?
(In previous places it was before the poetry :-)

tkatzir · 2024-11-10T17:30:03Z

content-repo/post_github_comment.py

@@ -135,7 +135,7 @@ def main():
 PR_NUM: if set will use this as the pull request number. Otherwise will move on to CIRCLE_PULL_REQUEST
 CIRCLE_PULL_REQUEST: pull request url to use to get the pull id. Such as: https://github.com/demisto/content-docs/pull/9
 if CIRCLE_PULL_REQUEST will try to get issue id from last commit comment (case of merge into master)
-CIRCLE_BRANCH: if set to master treats as a production deployment


CIRCLE_BRANCH still appears in the code above (e.g. line 109)

MosheEichler

Nice work!!
Approved with comments

MosheEichler · 2024-11-11T09:48:45Z

.pre-commit-config.yaml

+  - id: ruff
+    args:
+    - --fix
+    exclude: CommonServerPython.py


We may want to exclude demistomock as well

MosheEichler · 2024-11-11T10:18:12Z

.gitlab/ci/.gitlab-ci.yml

@@ -0,0 +1,8 @@
+variables:
+  CURRENT_BRANCH_NAME: infra-content-docs


Should it be master?

MosheEichler · 2024-11-11T10:18:45Z

.gitlab/ci/.gitlab-ci.yml

+
+include:
+  - file: "/.gitlab/ci/content-docs/.gitlab-ci.yml"
+    ref: infra-content-docs


The same ☝️

MosheEichler · 2024-11-11T10:19:19Z

.gitlab/helper_functions.sh

+#!/bin/bash
+
+CYAN="\e[0;36m"
+CLEAR="\e[0m"


Couldn't be in the end since we use it in line 5

kobymeir self-assigned this Sep 5, 2024

kobymeir force-pushed the infra-content-docs branch from cf713a1 to 487a091 Compare September 5, 2024 13:34

stale bot added the stale label Oct 5, 2024

stale bot removed the stale label Oct 6, 2024

kobymeir added 20 commits October 27, 2024 11:10

build content docs - take 1

6cf39f7

build content docs - take 2

934b72f

build content docs - take 3

a11a85a

build content docs - take 4

fa2d74b

build content docs - take 5

936a4e2

build content docs - take 6

57a341b

build content docs - take 7

222649d

build content docs - take 8

97a8bbe

build content docs - take 9

495da0a

build content docs - take 10

f0ff634

build content docs - take 11

aa3653a

build content docs - take 12

dba1e3e

build content docs - take 13

e237657

build content docs - take 14

69988ac

build content docs - take 15

9de50c7

build content docs - take 16

eeab2eb

build content docs - take 17

c69582c

build content docs - take 18

1eec8f0

build content docs - take 19

3d3c448

build content docs - take 19

ccca6d0

build content docs - take 20

10a66fd

kobymeir force-pushed the infra-content-docs branch from 4c27803 to 10a66fd Compare October 27, 2024 16:56

build content docs - take 20

e602588

kobymeir requested review from tkatzir and MosheEichler November 10, 2024 17:06

kobymeir marked this pull request as ready for review November 10, 2024 17:06

tkatzir approved these changes Nov 10, 2024

View reviewed changes

MosheEichler approved these changes Nov 11, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

build content docs - in gitlab #1619

build content docs - in gitlab #1619

kobymeir commented Sep 5, 2024

xsoar-bot commented Sep 5, 2024

xsoar-bot commented Sep 8, 2024

xsoar-bot commented Sep 9, 2024

stale bot commented Oct 5, 2024

xsoar-bot commented Oct 6, 2024

content-bot commented Oct 22, 2024

content-bot commented Oct 27, 2024

content-bot commented Oct 27, 2024

content-bot commented Oct 27, 2024

content-bot commented Nov 3, 2024

content-bot commented Nov 3, 2024

content-bot commented Nov 4, 2024

content-bot commented Nov 7, 2024

content-bot commented Nov 7, 2024

content-bot commented Nov 10, 2024

tkatzir left a comment

tkatzir Nov 10, 2024

tkatzir Nov 10, 2024

MosheEichler Nov 11, 2024

tkatzir Nov 10, 2024

tkatzir Nov 10, 2024

tkatzir Nov 10, 2024

tkatzir Nov 10, 2024

tkatzir Nov 10, 2024

tkatzir Nov 10, 2024

tkatzir Nov 10, 2024

tkatzir Nov 10, 2024

MosheEichler left a comment

MosheEichler Nov 11, 2024

MosheEichler Nov 11, 2024

MosheEichler Nov 11, 2024

MosheEichler Nov 11, 2024

	echo "section_start should be called with 1-3 args but it was called with $#"
	echo "section_start should be called with 1-3 args but it was called with $# args"

		@@ -0,0 +1,8 @@
		variables:
		CURRENT_BRANCH_NAME: infra-content-docs

		index.json
		/.firebase/hosting.YnVpbGQ.cache

build content docs - in gitlab #1619

Are you sure you want to change the base?

build content docs - in gitlab #1619

Conversation

kobymeir commented Sep 5, 2024

Status

Related Issues

Description

xsoar-bot commented Sep 5, 2024

Preview Site Available

xsoar-bot commented Sep 8, 2024

Preview Site Available

xsoar-bot commented Sep 9, 2024

Preview Site Available

stale bot commented Oct 5, 2024

xsoar-bot commented Oct 6, 2024

Preview Site Available

content-bot commented Oct 22, 2024

Preview Site Available

content-bot commented Oct 27, 2024

Preview Site Available

content-bot commented Oct 27, 2024

Preview Site Available

content-bot commented Oct 27, 2024

Preview Site Available

content-bot commented Nov 3, 2024

Preview Site Available

content-bot commented Nov 3, 2024

Preview Site Available

content-bot commented Nov 4, 2024

Preview Site Available

content-bot commented Nov 7, 2024

Preview Site Available

content-bot commented Nov 7, 2024

Preview Site Available

content-bot commented Nov 10, 2024

Preview Site Available

tkatzir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MosheEichler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment