Skip to content

Commit 12001d9

Browse files
jrmadsenjrmadsen
authored
Fix release workflow (#228)
- remove docs updates and release step from cpack.yml workflow - create docs.yml workflow - create release.yml workflow - update source/docs/environment.yml - add status badge for documentation
1 parent 1f35d58 commit 12001d9

File tree

5 files changed

+301
-75
lines changed

5 files changed

+301
-75
lines changed

‎.github/workflows/cpack.yml

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -19,64 +19,6 @@ env:
1919
GIT_DISCOVERY_ACROSS_FILESYSTEM: 1
2020

2121
jobs:
22-
release:
23-
if: github.repository == 'AMDResearch/omnitrace' && startsWith(github.ref, 'refs/tags/')
24-
runs-on: ubuntu-20.04
25-
permissions:
26-
contents: write
27-
packages: write
28-
steps:
29-
- name: Checkout
30-
uses: actions/checkout@v3
31-
- name: Generate generic installer script
32-
shell: bash
33-
run: |
34-
apt-get update
35-
apt-get install -y cmake
36-
cmake -D OUTPUT_DIR=${PWD} -P scripts/write-omnitrace-install.cmake
37-
- name: Generate Release
38-
uses: softprops/action-gh-release@v1
39-
with:
40-
draft: False
41-
generate_release_notes: True
42-
fail_on_unmatched_files: True
43-
files: |
44-
omnitrace-install.py
45-
46-
release-docs:
47-
if: github.repository == 'AMDResearch/omnitrace' && (startsWith(github.ref, 'refs/tags/') || contains(github.ref, 'releases/'))
48-
runs-on: ubuntu-20.04
49-
permissions:
50-
contents: write
51-
packages: write
52-
steps:
53-
- name: Checkout
54-
uses: actions/checkout@v3
55-
- name: Update Source
56-
run: |
57-
git config --global user.name 'Jonathan R. Madsen'
58-
git config --global user.email '[email protected]'
59-
git config --global pull.rebase true
60-
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
61-
git fetch origin
62-
git checkout gh-pages
63-
git pull origin main
64-
- name: Install Conda
65-
uses: s-weigand/setup-conda@v1
66-
- name: Update Docs
67-
working-directory: source/docs
68-
run: |
69-
conda env create -n omnitrace-docs -f environment.yml
70-
source activate
71-
conda activate omnitrace-docs
72-
./update-docs.sh
73-
- name: Push changes
74-
if: github.repository == 'AMDResearch/omnitrace' && startsWith(github.ref, 'refs/tags/')
75-
run: |
76-
git add docs
77-
git commit -m "Update HTML (automated)"
78-
git push -f
79-
8022
installers:
8123
if: github.repository == 'AMDResearch/omnitrace'
8224
runs-on: ubuntu-20.04

‎.github/workflows/docs.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Documentation
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches: [main, gh-pages]
7+
paths:
8+
- '*.md'
9+
- 'source/docs/**'
10+
- '.github/workflows/docs.yml'
11+
- 'VERSION'
12+
pull_request:
13+
branches: [main]
14+
paths:
15+
- '*.md'
16+
- 'source/docs/**'
17+
- '.github/workflows/docs.yml'
18+
- 'VERSION'
19+
20+
concurrency:
21+
group: ${{ github.workflow }}-${{ github.ref }}
22+
cancel-in-progress: true
23+
24+
env:
25+
GIT_DISCOVERY_ACROSS_FILESYSTEM: 1
26+
27+
jobs:
28+
build-docs:
29+
runs-on: ubuntu-20.04
30+
permissions:
31+
contents: read
32+
pages: write
33+
id-token: write
34+
steps:
35+
- name: Checkout
36+
uses: actions/checkout@v3
37+
- name: Install Conda
38+
uses: s-weigand/setup-conda@v1
39+
- name: Setup Pages
40+
uses: actions/configure-pages@v2
41+
- name: Create Docs Directory
42+
run:
43+
mkdir -p docs
44+
- name: Update Docs
45+
working-directory: source/docs
46+
run: |
47+
conda env create -n omnitrace-docs -f environment.yml
48+
source activate
49+
conda activate omnitrace-docs
50+
./update-docs.sh
51+
- name: Upload artifact
52+
uses: actions/upload-pages-artifact@v1
53+
with:
54+
path: ./docs
55+
56+
deploy-docs:
57+
if: github.repository == 'AMDResearch/omnitrace' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/gh-pages')
58+
runs-on: ubuntu-20.04
59+
needs: build-docs
60+
permissions:
61+
contents: read
62+
pages: write
63+
id-token: write
64+
environment:
65+
name: github-pages
66+
url: ${{ steps.deployment.outputs.page_url }}
67+
steps:
68+
- name: Deploy to GitHub Pages
69+
id: deployment
70+
uses: actions/deploy-pages@v1

‎.github/workflows/release.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Release
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
tags:
7+
- v*
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
env:
14+
GIT_DISCOVERY_ACROSS_FILESYSTEM: 1
15+
16+
jobs:
17+
release:
18+
if: github.repository == 'AMDResearch/omnitrace'
19+
runs-on: ubuntu-20.04
20+
permissions:
21+
contents: write
22+
packages: write
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v3
26+
- name: Generate generic installer script
27+
shell: bash
28+
run: |
29+
sudo apt-get update
30+
sudo apt-get install -y cmake
31+
cmake -D OUTPUT_DIR=${PWD} -P scripts/write-omnitrace-install.cmake
32+
- name: Generate Release
33+
uses: softprops/action-gh-release@v1
34+
with:
35+
draft: False
36+
generate_release_notes: True
37+
fail_on_unmatched_files: True
38+
files: |
39+
omnitrace-install.py

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
[![Ubuntu 22.04 (GCC, Python, ROCm)](https://github.com/AMDResearch/omnitrace/actions/workflows/ubuntu-jammy.yml/badge.svg)](https://github.com/AMDResearch/omnitrace/actions/workflows/ubuntu-jammy.yml)
66
[![OpenSUSE 15.x with GCC](https://github.com/AMDResearch/omnitrace/actions/workflows/opensuse.yml/badge.svg)](https://github.com/AMDResearch/omnitrace/actions/workflows/opensuse.yml)
77
[![Installer Packaging (CPack)](https://github.com/AMDResearch/omnitrace/actions/workflows/cpack.yml/badge.svg)](https://github.com/AMDResearch/omnitrace/actions/workflows/cpack.yml)
8+
[![Documentation](https://github.com/AMDResearch/omnitrace/actions/workflows/docs.yml/badge.svg)](https://github.com/AMDResearch/omnitrace/actions/workflows/docs.yml)
89

910
> ***[Omnitrace](https://github.com/AMDResearch/omnitrace) is an AMD open source research project and is not supported as part of the ROCm software stack.***
1011

‎source/docs/environment.yml

Lines changed: 191 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,194 @@ channels:
33
- conda-forge
44
- defaults
55
dependencies:
6-
- python=3.9
7-
- cmake
8-
- curl
9-
- doxygen
10-
- git
11-
- graphviz
12-
- matplotlib
13-
- mkdocs
14-
- numpy
15-
- openssl
16-
- pillow
17-
- pip
18-
- setuptools
19-
- breathe <4.30.0
20-
- sphinx <4.0.0
21-
- sphinx-markdown-tables
22-
- docutils
6+
- _libgcc_mutex=0.1=conda_forge
7+
- _openmp_mutex=4.5=1_gnu
8+
- alabaster=0.7.12=py_0
9+
- alsa-lib=1.2.3=h516909a_0
10+
- argh=0.26.2=pyh9f0ad1d_1002
11+
- atk-1.0=2.36.0=h3371d22_4
12+
- babel=2.9.1=pyh44b312d_0
13+
- breathe=4.29.2=pyhd8ed1ab_0
14+
- brotli=1.0.9=h7f98852_6
15+
- brotli-bin=1.0.9=h7f98852_6
16+
- brotlipy=0.7.0=py39h3811e60_1003
17+
- bzip2=1.0.8=h7f98852_4
18+
- c-ares=1.18.1=h7f98852_0
19+
- ca-certificates=2021.10.8=ha878542_0
20+
- cairo=1.16.0=ha00ac49_1009
21+
- certifi=2021.10.8=py39hf3d152e_1
22+
- cffi=1.15.0=py39h4bc2ebd_0
23+
- charset-normalizer=2.0.12=pyhd8ed1ab_0
24+
- click=8.0.4=py39hf3d152e_0
25+
- cmake=3.22.2=h1021d11_0
26+
- colorama=0.4.4=pyh9f0ad1d_0
27+
- commonmark=0.9.1=py_0
28+
- cryptography=36.0.1=py39h95dcef6_0
29+
- curl=7.81.0=h2574ce0_0
30+
- cycler=0.11.0=pyhd8ed1ab_0
31+
- dbus=1.13.6=h5008d03_3
32+
- docutils=0.16=py39hf3d152e_3
33+
- doxygen=1.9.2=hb166930_0
34+
- expat=2.4.4=h9c3ff4c_0
35+
- font-ttf-dejavu-sans-mono=2.37=hab24e00_0
36+
- font-ttf-inconsolata=3.000=h77eed37_0
37+
- font-ttf-source-code-pro=2.038=h77eed37_0
38+
- font-ttf-ubuntu=0.83=hab24e00_0
39+
- fontconfig=2.13.96=ha180cfb_0
40+
- fonts-conda-ecosystem=1=0
41+
- fonts-conda-forge=1=0
42+
- fonttools=4.29.1=py39h3811e60_0
43+
- freetype=2.10.4=h0708190_1
44+
- fribidi=1.0.10=h36c2ea0_0
45+
- future=0.18.2=py39hf3d152e_4
46+
- gdk-pixbuf=2.42.6=h04a7f16_0
47+
- gettext=0.19.8.1=h73d1719_1008
48+
- ghp-import=2.0.2=pyhd8ed1ab_0
49+
- giflib=5.2.1=h36c2ea0_2
50+
- git=2.35.0=pl5321hc30692c_0
51+
- graphite2=1.3.13=h58526e2_1001
52+
- graphviz=2.50.0=h8e749b2_2
53+
- gst-plugins-base=1.18.5=hf529b03_3
54+
- gstreamer=1.18.5=h9f60fe5_3
55+
- gtk2=2.24.33=h90689f9_2
56+
- gts=0.7.6=h64030ff_2
57+
- harfbuzz=3.4.0=hb4a5f5f_0
58+
- icu=69.1=h9c3ff4c_0
59+
- idna=3.3=pyhd8ed1ab_0
60+
- imagesize=1.3.0=pyhd8ed1ab_0
61+
- importlib-metadata=4.11.1=py39hf3d152e_0
62+
- jbig=2.1=h7f98852_2003
63+
- jinja2=3.0.3=pyhd8ed1ab_0
64+
- jpeg=9e=h7f98852_0
65+
- kiwisolver=1.3.2=py39h1a9c180_1
66+
- krb5=1.19.2=hcc1bbae_3
67+
- lcms2=2.12=hddcbb42_0
68+
- ld_impl_linux-64=2.36.1=hea4e1c9_2
69+
- lerc=3.0=h9c3ff4c_0
70+
- libblas=3.9.0=13_linux64_openblas
71+
- libbrotlicommon=1.0.9=h7f98852_6
72+
- libbrotlidec=1.0.9=h7f98852_6
73+
- libbrotlienc=1.0.9=h7f98852_6
74+
- libcblas=3.9.0=13_linux64_openblas
75+
- libclang=13.0.1=default_hc23dcda_0
76+
- libcurl=7.81.0=h2574ce0_0
77+
- libdeflate=1.10=h7f98852_0
78+
- libedit=3.1.20191231=he28a2e2_2
79+
- libev=4.33=h516909a_1
80+
- libevent=2.1.10=h9b69904_4
81+
- libffi=3.4.2=h7f98852_5
82+
- libgcc-ng=11.2.0=h1d223b6_12
83+
- libgd=2.3.3=h3cfcdeb_1
84+
- libgfortran-ng=11.2.0=h69a702a_12
85+
- libgfortran5=11.2.0=h5c6108e_12
86+
- libglib=2.70.2=h174f98d_4
87+
- libgomp=11.2.0=h1d223b6_12
88+
- libiconv=1.16=h516909a_0
89+
- liblapack=3.9.0=13_linux64_openblas
90+
- libllvm13=13.0.1=hf817b99_0
91+
- libnghttp2=1.46.0=h812cca2_0
92+
- libnsl=2.0.0=h7f98852_0
93+
- libogg=1.3.4=h7f98852_1
94+
- libopenblas=0.3.18=pthreads_h8fe5266_0
95+
- libopus=1.3.1=h7f98852_1
96+
- libpng=1.6.37=h21135ba_2
97+
- libpq=14.2=hd57d9b9_0
98+
- librsvg=2.52.5=h0a9e6e8_2
99+
- libssh2=1.10.0=ha56f1ee_2
100+
- libstdcxx-ng=11.2.0=he4da1e4_12
101+
- libtiff=4.3.0=h542a066_3
102+
- libtool=2.4.6=h9c3ff4c_1008
103+
- libuuid=2.32.1=h7f98852_1000
104+
- libuv=1.43.0=h7f98852_0
105+
- libvorbis=1.3.7=h9c3ff4c_0
106+
- libwebp=1.2.2=h3452ae3_0
107+
- libwebp-base=1.2.2=h7f98852_1
108+
- libxcb=1.13=h7f98852_1004
109+
- libxkbcommon=1.0.3=he3ba5ed_0
110+
- libxml2=2.9.12=h885dcf4_1
111+
- libzlib=1.2.11=h36c2ea0_1013
112+
- lz4-c=1.9.3=h9c3ff4c_1
113+
- markdown=3.3.6=pyhd8ed1ab_0
114+
- markupsafe=2.1.0=py39hb9d737c_0
115+
- matplotlib=3.5.1=py39hf3d152e_0
116+
- matplotlib-base=3.5.1=py39h2fa2bec_0
117+
- mergedeep=1.3.4=pyhd8ed1ab_0
118+
- mkdocs=1.2.3=pyhd8ed1ab_0
119+
- munkres=1.1.4=pyh9f0ad1d_0
120+
- mysql-common=8.0.28=ha770c72_0
121+
- mysql-libs=8.0.28=hfa10184_0
122+
- ncurses=6.3=h9c3ff4c_0
123+
- nspr=4.32=h9c3ff4c_1
124+
- nss=3.74=hb5efdd6_0
125+
- numpy=1.22.2=py39h91f2184_0
126+
- openjpeg=2.4.0=hb52868f_1
127+
- openssl=1.1.1l=h7f98852_0
128+
- packaging=21.3=pyhd8ed1ab_0
129+
- pango=1.50.3=h9967ed3_0
130+
- pcre=8.45=h9c3ff4c_0
131+
- pcre2=10.37=h032f7d1_0
132+
- perl=5.32.1=2_h7f98852_perl5
133+
- pillow=9.0.1=py39hae2aec6_2
134+
- pip=22.0.3=pyhd8ed1ab_0
135+
- pixman=0.40.0=h36c2ea0_0
136+
- pthread-stubs=0.4=h36c2ea0_1001
137+
- pycparser=2.21=pyhd8ed1ab_0
138+
- pygments=2.11.2=pyhd8ed1ab_0
139+
- pyopenssl=22.0.0=pyhd8ed1ab_0
140+
- pyparsing=3.0.7=pyhd8ed1ab_0
141+
- pyqt=5.12.3=py39hf3d152e_8
142+
- pyqt-impl=5.12.3=py39hde8b62d_8
143+
- pyqt5-sip=4.19.18=py39he80948d_8
144+
- pyqtchart=5.12=py39h0fcd23e_8
145+
- pyqtwebengine=5.12.1=py39h0fcd23e_8
146+
- pysocks=1.7.1=py39hf3d152e_4
147+
- python=3.9.10=h85951f9_2_cpython
148+
- python-dateutil=2.8.2=pyhd8ed1ab_0
149+
- python_abi=3.9=2_cp39
150+
- pytz=2021.3=pyhd8ed1ab_0
151+
- pyyaml=6.0=py39h3811e60_3
152+
- pyyaml-env-tag=0.1=pyhd8ed1ab_0
153+
- qt=5.12.9=ha98a1a1_5
154+
- readline=8.1=h46c0cb4_0
155+
- recommonmark=0.7.1=pyhd8ed1ab_0
156+
- requests=2.27.1=pyhd8ed1ab_0
157+
- rhash=1.4.1=h7f98852_0
158+
- setuptools=60.9.3=py39hf3d152e_0
159+
- six=1.16.0=pyh6c4a22f_0
160+
- snowballstemmer=2.2.0=pyhd8ed1ab_0
161+
- sphinx=3.5.4=pyh44b312d_0
162+
- sphinx-markdown-tables=0.0.15=pyhd3deb0d_0
163+
- sphinxcontrib-applehelp=1.0.2=py_0
164+
- sphinxcontrib-devhelp=1.0.2=py_0
165+
- sphinxcontrib-htmlhelp=2.0.0=pyhd8ed1ab_0
166+
- sphinxcontrib-jsmath=1.0.1=py_0
167+
- sphinxcontrib-qthelp=1.0.3=py_0
168+
- sphinxcontrib-serializinghtml=1.1.5=pyhd8ed1ab_1
169+
- sqlite=3.37.0=h9cd32fc_0
170+
- tk=8.6.12=h27826a3_0
171+
- tornado=6.1=py39h3811e60_2
172+
- tzdata=2021e=he74cb21_0
173+
- unicodedata2=14.0.0=py39h3811e60_0
174+
- urllib3=1.26.8=pyhd8ed1ab_1
175+
- watchdog=2.1.6=py39hf3d152e_1
176+
- wheel=0.37.1=pyhd8ed1ab_0
177+
- xorg-kbproto=1.0.7=h7f98852_1002
178+
- xorg-libice=1.0.10=h7f98852_0
179+
- xorg-libsm=1.2.3=hd9c2040_1000
180+
- xorg-libx11=1.7.2=h7f98852_0
181+
- xorg-libxau=1.0.9=h7f98852_0
182+
- xorg-libxdmcp=1.1.3=h7f98852_0
183+
- xorg-libxext=1.3.4=h7f98852_1
184+
- xorg-libxrender=0.9.10=h7f98852_1003
185+
- xorg-renderproto=0.11.1=h7f98852_1002
186+
- xorg-xextproto=7.3.0=h7f98852_1002
187+
- xorg-xproto=7.0.31=h7f98852_1007
188+
- xz=5.2.5=h516909a_1
189+
- yaml=0.2.5=h7f98852_2
190+
- zipp=3.7.0=pyhd8ed1ab_1
191+
- zlib=1.2.11=h36c2ea0_1013
192+
- zstd=1.5.2=ha95c52a_0
193+
- pip:
194+
- py-gfm==1.0.2
195+
- sphinx-markdown==1.0.2
196+
- sphinx-rtd-theme==1.0.0

0 commit comments

Comments
 (0)