FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
python-docs-pt-br/.github/workflows/check.yml at main · python/python-docs-pt-br · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
python
/
python-docs-pt-br
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
41
Star
161
Code
Issues
13
Pull requests
4
Actions
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
python-docs-pt-br
/
.github
/
workflows
/
check.yml
Copy path
View runs
More file actions
More file actions
Latest commit
History
History
History
221 lines (190 loc) · 7.46 KB
Breadcrumbs
python-docs-pt-br
/
.github
/
workflows
/
check.yml
Copy path
File metadata and controls
221 lines (190 loc) · 7.46 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
#
Run some tests in the Python Doc translations
name
:
Check
on
:
workflow_dispatch
:
inputs
:
version
:
description
:
"
Branch name corresponding to a Python version
"
required
:
true
type
:
string
tx_project
:
description
:
"
Name of the Transifex translation project
"
required
:
true
type
:
string
workflow_call
:
inputs
:
version
:
description
:
"
Branch name corresponding to a Python version
"
required
:
true
type
:
string
tx_project
:
description
:
"
Name of the Transifex translation project
"
required
:
true
type
:
string
secrets
:
telegram_token
:
description
:
"
Token required for interacting with Telegram API
"
required
:
false
telegram_to
:
description
:
"
Account ID that will receive the telegram notification
"
required
:
false
permissions
:
contents
:
read
env
:
PYDOC_LANGUAGE
:
pt_BR
PYDOC_REPO
:
${{ github.server_url }}/${{ github.repository }}
PYDOC_VERSION
:
${{ inputs.version }}
jobs
:
#
Build documentation handling warnings as errors in both HTML and PDF.
#
If success, upload built docs as artifact.
#
If failure in HTML, notify telegram and upload logs.
build
:
name
:
Build docs
runs-on
:
ubuntu-latest
strategy
:
fail-fast
:
false
matrix
:
format
:
[ html, latex, epub ]
steps
:
-
uses
:
actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
#
v7.0.1
with
:
fetch-depth
:
5
persist-credentials
:
false
-
name
:
Set up Python 3
uses
:
actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97
#
v7.0.0
with
:
python-version
:
${{ inputs.version }}
cache
:
pip
allow-prereleases
:
true
-
name
:
Make sure the repository is up to date
if
:
github.event_name != 'pull_request'
run
:
git pull --rebase
-
name
:
setup
run
:
./scripts/setup.sh
-
name
:
Install APT dependencies
if
:
matrix.format == 'latex'
run
:
sudo apt update -y && sudo apt install librsvg2-bin -y
-
name
:
Add problem matcher
uses
:
sphinx-doc/github-problem-matcher@1f74d6599f4a5e89a20d3c99aab4e6a70f7bda0f
#
v1.1
-
name
:
Build docs
id
:
build
run
:
./scripts/build.sh ${{ matrix.format }}
-
name
:
Prepare notification (only on error)
if
:
always() && steps.build.outcome == 'failure' && matrix.format == 'html'
id
:
prepare
run
:
|
scripts/prepmsg.sh logs/sphinxwarnings-${{ matrix.format }}.txt logs/notify.txt
cat logs/notify.txt
env
:
GITHUB_JOB
:
${{ github.job }}
GITHUB_RUN_ID
:
${{ github.run_id }}
-
name
:
Notify via Telegram
if
:
always() && steps.prepare.outcome == 'success' && github.event_name == 'schedule' && inputs.tx_project == 'python-newest'
uses
:
appleboy/telegram-action@214f06cfa3d3a588c1472116889437e7c6fd29b1
#
v1.1.1
with
:
to
:
${{ secrets.telegram_to }}
token
:
${{ secrets.telegram_token }}
format
:
markdown
disable_web_page_preview
:
true
message_file
:
logs/notify.txt
-
name
:
Upload artifact - log files
if
:
always() && steps.build.outcome == 'failure'
uses
:
actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
#
v7.0.1
with
:
name
:
logs-${{ inputs.version }}-${{ matrix.format }}
path
:
logs/*
-
name
:
Upload artifact - docs
if
:
always() && steps.build.outcome == 'success'
uses
:
actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
#
v7.0.1
with
:
name
:
python-docs-pt-br-${{ inputs.version }}-${{ matrix.format }}
path
:
cpython/Doc/build/${{ matrix.format }}
#
Build Python docs in PDF format and make available for download.
output-pdf
:
name
:
Build docs (pdf)
runs-on
:
ubuntu-latest
needs
:
[ 'build' ]
steps
:
-
uses
:
actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c
#
v8.0.1
with
:
name
:
python-docs-pt-br-${{ inputs.version }}-latex
-
run
:
sudo apt-get update
-
run
:
sudo apt-get install -y latexmk texlive-xetex fonts-freefont-otf xindy texlive-lang-portuguese
-
run
:
make
-
uses
:
actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
#
v7.0.1
if
:
always()
with
:
name
:
python-docs-pt-br-${{ inputs.version }}-pdf
path
:
./*.pdf
#
Run sphinx-lint to find wrong reST syntax in PO files. Always store logs.
#
If issues are found, notify telegram and upload logs.
lint
:
name
:
Lint translations
runs-on
:
ubuntu-latest
steps
:
-
uses
:
actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
#
v7.0.1
with
:
fetch-depth
:
5
persist-credentials
:
false
-
name
:
Set up Python 3
uses
:
actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97
#
v7.0.0
with
:
python-version
:
${{ inputs.version }}
cache
:
pip
allow-prereleases
:
true
-
name
:
Make sure the repository is up to date
if
:
github.event_name != 'pull_request'
run
:
git pull --rebase
-
name
:
setup
run
:
./scripts/setup.sh
-
name
:
Add problem matcher
uses
:
rffontenelle/sphinx-lint-problem-matcher@4270bf50b2c93640a7cbb231c09f8e694699af9f
#
v1.0.0
-
name
:
lint translations files
id
:
lint
run
:
./scripts/lint.sh
-
name
:
Prepare notification (only on error)
if
:
always() && steps.lint.outcome == 'failure'
id
:
prepare
run
:
|
scripts/prepmsg.sh logs/sphinxlint.txt logs/notify.txt
cat logs/notify.txt
env
:
GITHUB_JOB
:
${{ github.job }}
GITHUB_RUN_ID
:
${{ github.run_id }}
-
name
:
Notify via Telegram
if
:
always() && steps.prepare.outcome == 'success' && github.event_name == 'schedule' && inputs.tx_project == 'python-newest'
uses
:
appleboy/telegram-action@214f06cfa3d3a588c1472116889437e7c6fd29b1
#
v1.1.1
with
:
to
:
${{ secrets.telegram_to }}
token
:
${{ secrets.telegram_token }}
format
:
markdown
disable_web_page_preview
:
true
message_file
:
logs/notify.txt
-
name
:
Upload artifact - log files
if
:
always() && steps.lint.outcome == 'failure'
uses
:
actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
#
v7.0.1
with
:
name
:
${{ inputs.version }}-lint-logs
path
:
logs/*
#
Check for zero-width space charcters in translations.
#
These are known to come together with (some?) machine translation like Google translate,
#
and - as one of the consequences - it may avoid Transifex glossary matching (e.g. variáveis)
zero-width-space
:
name
:
Check for zero-width space characters
runs-on
:
ubuntu-latest
steps
:
-
uses
:
actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
#
v7.0.1
with
:
ref
:
${{ inputs.version }}
persist-credentials
:
false
-
name
:
Make sure the repository is up to date
if
:
github.event_name != 'pull_request'
run
:
git pull --rebase
-
name
:
Remove zero-width space characters
run
:
|
sed -i 's/\xe2\x80\x8b//g' *.po **/*.po
# Undo removal from where we should not
sed -i 's|`````|`````|' reference/lexical_analysis.po
-
name
:
Show difference (error if there is any)
run
:
|
git diff --exit-code --color-words
Back
|
FazBrowse Home
|
New Git URL