Create Github Action for committing and pushing changes to submodules #256

glatosinski · 2020-11-24T11:51:46Z

This PR shows an example flow of generating intermediate results required for making the documentation and pushing them to respective submodules.

Signed-off-by: Karol Gugala <[email protected]>

mithro

Everything (apart from the GitHub action) looks to be going in the right direction.

.github/workflows/generate-rst.yml

mithro · 2020-11-24T15:23:38Z

.github/workflows/generate-rst.yml

+          sudo apt install -y python3 python3-pip git tar gzip
+          pip3 install docutils sphinx
+
+          SUBMODULE_VERSION=latest make submodules -j3 || make submodules -j1


git submodule update --init --recursive ?

git submodule update --init --recursive will fetch all the submodules and we need only the latest ones

scripts/python-skywater-pdk/skywater_pdk/cell_list.py

scripts/python-skywater-pdk/skywater_pdk/netlistsvg-generate.py

scripts/python-skywater-pdk/skywater_pdk/cell-readme-generate.py

… cell_doc_tree

google-cla · 2020-11-25T21:48:08Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2020-11-25T21:51:21Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2020-11-26T08:38:21Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2020-11-26T08:48:32Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2020-11-26T11:43:15Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2020-11-26T12:20:40Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

wgryncewicz · 2020-11-26T12:34:16Z

@googlebot I consent.

google-cla · 2020-11-26T12:34:29Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

kgugala · 2020-11-26T12:39:12Z

@googlebot I consent.

google-cla · 2020-11-26T12:39:26Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

glatosinski · 2020-11-26T12:43:26Z

@mithro could you please add a consent? I was updating this branch based on antmicro:cell_doc_tree and two your commits were added here

EDIT: the consent is not required, sorry for unnecessary message

Signed-off-by: Grzegorz Latosinski <[email protected]>

wgryncewicz and others added 4 commits November 19, 2020 15:34

Proto of cell README generator

0ca0b29

cell_list generator and lib README patcher

9fcefb0

Cell_list now appends links to cell readmes

c74b4d8

Docs: generate cells documentation in CI

5eb305b

Signed-off-by: Karol Gugala <[email protected]>

github-actions bot added documentation Improvements or additions to documentation infrastructure Issues related with infrastructure like Travis-CI, Kokoro or other similar automated tooling. labels Nov 24, 2020

mithro suggested changes Nov 24, 2020

View reviewed changes

wgryncewicz added 4 commits November 25, 2020 13:44

netlistsvg-generate removed - belongs to another branch

9db2820

Cell readme generator updated, includes GDS2 layouts

b366982

Cell list generator includes cell links in table

10c5e8f

Merge branch 'cell_doc_tree' of github.com:antmicro/skywater-pdk into…

ab19ce3

… cell_doc_tree

glatosinski force-pushed the cell_doc_tree_commit branch 4 times, most recently from dafe2b7 to 24b6907 Compare November 25, 2020 19:19

wgryncewicz added 3 commits November 25, 2020 21:43

Removed redundant cell_list Sphinx extension script

1f3fcbb

Rename cell readme generator script

ed83490

Rename cell list generator script

3f498d9

glatosinski force-pushed the cell_doc_tree_commit branch from b9b8233 to a965f76 Compare November 25, 2020 21:47

glatosinski force-pushed the cell_doc_tree_commit branch from 8607424 to f75e1d8 Compare November 26, 2020 08:48

glatosinski force-pushed the cell_doc_tree_commit branch from 792c596 to a10e825 Compare November 26, 2020 12:20

glatosinski added 9 commits November 26, 2020 13:58

Added committing changes made to submodules

98da26c

Signed-off-by: Grzegorz Latosinski <[email protected]>

github-actions: cleaned up generate-rst, added using conda

550cab4

Signed-off-by: Grzegorz Latosinski <[email protected]>

github-actions: added docutils to requirements.txt

058f1d0

Signed-off-by: Grzegorz Latosinski <[email protected]>

github-actions: added activating conda environment

3ecbc35

Signed-off-by: Grzegorz Latosinski <[email protected]>

github-actions: fixed name for cell_readme_generate

43ea361

Signed-off-by: Grzegorz Latosinski <[email protected]>

github-actions: added ignoring failing commits in submodules

c594c49

Signed-off-by: Grzegorz Latosinski <[email protected]>

github-actions: updated script names in generate-rst

6a50169

Signed-off-by: Grzegorz Latosinski <[email protected]>

github-actions: cleaned up generate-rst

4dbb833

Signed-off-by: Grzegorz Latosinski <[email protected]>

github-actions: silenced git commands

cc86239

Signed-off-by: Grzegorz Latosinski <[email protected]>

glatosinski force-pushed the cell_doc_tree_commit branch from a10e825 to cc86239 Compare November 26, 2020 12:58

github-actions bot removed the documentation Improvements or additions to documentation label Nov 26, 2020

glatosinski requested a review from mithro November 27, 2020 11:07

wgryncewicz mentioned this pull request Nov 27, 2020

86 cell cross index #266

Merged

This was referenced May 30, 2022

docs: Add generator for cell index #143

Open

Write a "cell index / table" generator for the documentation #86

Closed

Create Github Action for committing and pushing changes to submodules #256

Are you sure you want to change the base?

Create Github Action for committing and pushing changes to submodules #256

Uh oh!

Conversation

glatosinski commented Nov 24, 2020

Uh oh!

mithro left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mithro Nov 24, 2020

Choose a reason for hiding this comment

Uh oh!

kgugala Nov 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

google-cla bot commented Nov 25, 2020

Uh oh!

google-cla bot commented Nov 25, 2020

Uh oh!

google-cla bot commented Nov 26, 2020

Uh oh!

google-cla bot commented Nov 26, 2020

Uh oh!

google-cla bot commented Nov 26, 2020

Uh oh!

google-cla bot commented Nov 26, 2020

Uh oh!

wgryncewicz commented Nov 26, 2020

Uh oh!

google-cla bot commented Nov 26, 2020

Uh oh!

kgugala commented Nov 26, 2020

Uh oh!

google-cla bot commented Nov 26, 2020

Uh oh!

glatosinski commented Nov 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kgugala Nov 24, 2020 •

edited

Loading

glatosinski commented Nov 26, 2020 •

edited

Loading