Skip to content

Commit 8dabbf4

Browse files
carlosperatecarlosperate
committed
Action: Minor refactor to rename 'tweet' to generic 'post'.
1 parent 0e95504 commit 8dabbf4

File tree

3 files changed

+53
-53
lines changed

3 files changed

+53
-53
lines changed

‎.github/actions/tweet-commit/entrypoint.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ if [[ "$1" == "test" ]]; then
1313
echo "Running the tests:"
1414
python .github/actions/tweet-commit/tests.py
1515
echo "Running flake8:"
16-
flake8 .github/actions/tweet-commit/tweet_commit.py .github/actions/tweet-commit/tests.py
16+
flake8 .github/actions/tweet-commit/post_commit.py .github/actions/tweet-commit/tests.py
1717
echo "Running black:"
18-
black .github/actions/tweet-commit/tweet_commit.py .github/actions/tweet-commit/tests.py --check --diff --line-length 79
18+
black .github/actions/tweet-commit/post_commit.py .github/actions/tweet-commit/tests.py --check --diff --line-length 79
1919
else
2020
echo "Tweeting new Awesome List entry:"
21-
python .github/actions/tweet-commit/tweet_commit.py
21+
python .github/actions/tweet-commit/post_commit.py
2222
fi

‎.github/actions/tweet-commit/tweet_commit.py renamed to ‎.github/actions/tweet-commit/post_commit.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def get_entry_section(readme_str, list_entry):
9090
raise Exception("Could not find a section for the Awesome List entry.")
9191

9292

93-
def format_tweet_msg(section, title, url, description):
93+
def format_post_msg(section, title, url, description):
9494
"""Format a tweet combining the title, description and URL.
9595
9696
It ensures the total size does not exceed the tweet max characters limit.
@@ -151,12 +151,12 @@ def tweet_msg(msg):
151151
def main():
152152
"""Entry point."""
153153
commit_hash = os.environ["GITHUB_SHA"]
154-
tweet_trigger_str = os.environ["INPUT_TRIGGER_KEYWORD"]
155-
print("Commit: {}\nTrigger: {}".format(commit_hash, tweet_trigger_str))
154+
post_trigger_str = os.environ["INPUT_TRIGGER_KEYWORD"]
155+
print("Commit: {}\nTrigger: {}".format(commit_hash, post_trigger_str))
156156

157157
repo = Repo(os.getcwd())
158158
commit = repo.commit(commit_hash)
159-
if tweet_trigger_str not in commit.message:
159+
if post_trigger_str not in commit.message:
160160
print("Tweet trigger keyword not found, exiting...")
161161
sys.exit(0)
162162

@@ -165,7 +165,7 @@ def main():
165165
readme = get_commit_readme(commit)
166166
for i, entry in enumerate(entries):
167167
section = get_entry_section(readme, entry["entry"])
168-
msg = format_tweet_msg(
168+
msg = format_post_msg(
169169
section, entry["title"], entry["url"], entry["description"]
170170
)
171171
print(

‎.github/actions/tweet-commit/tests.py

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
"""Tests for tweet_commit."""
1+
"""Tests for post_commit."""
22

33
import os
44
import unittest
55

66
from git import Repo
77

88
try:
9-
import tweet_commit
9+
import post_commit as post_commit
1010
except ImportError:
1111
os.chdir(os.path.dirname(os.path.realpath(__file__)))
12-
import tweet_commit
12+
import post_commit as post_commit
1313

1414

1515
class TestCommitTweet(unittest.TestCase):
@@ -25,17 +25,17 @@ def get_commit_data(self, commit_hash):
2525
repository_path = os.getcwd()
2626
repo = Repo(repository_path)
2727
commit = repo.commit(commit_hash)
28-
entries = tweet_commit.get_commit_list_entries(commit)
29-
readme = tweet_commit.get_commit_readme(commit)
28+
entries = post_commit.get_commit_list_entries(commit)
29+
readme = post_commit.get_commit_readme(commit)
3030
return entries, readme
3131

3232
def test_commit_1(self):
3333
"""Normal commit."""
3434
entries, readme = self.get_commit_data(
3535
"2c58c69cd5ea09fe15726d60c40faaccc6735921"
3636
)
37-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
38-
tweet = tweet_commit.format_tweet_msg(
37+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
38+
tweet = post_commit.format_post_msg(
3939
section,
4040
entries[0]["title"],
4141
entries[0]["url"],
@@ -60,8 +60,8 @@ def test_commit_2(self):
6060
entries, readme = self.get_commit_data(
6161
"401d6c4ee70d21dd86631eb377433b319cbb88d1"
6262
)
63-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
64-
tweet = tweet_commit.format_tweet_msg(
63+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
64+
tweet = post_commit.format_post_msg(
6565
section,
6666
entries[0]["title"],
6767
entries[0]["url"],
@@ -87,8 +87,8 @@ def test_commit_3(self):
8787
entries, readme = self.get_commit_data(
8888
"2faac881c36435b45a454989ca915f50fe919c94"
8989
)
90-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
91-
tweet = tweet_commit.format_tweet_msg(
90+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
91+
tweet = post_commit.format_post_msg(
9292
section,
9393
entries[0]["title"],
9494
entries[0]["url"],
@@ -120,8 +120,8 @@ def test_commit_5(self):
120120
entries, readme = self.get_commit_data(
121121
"d8eaa108e6fbb635f282f341e64b7b36507f0788"
122122
)
123-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
124-
tweet = tweet_commit.format_tweet_msg(
123+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
124+
tweet = post_commit.format_post_msg(
125125
section,
126126
entries[0]["title"],
127127
entries[0]["url"],
@@ -150,8 +150,8 @@ def test_commit_6(self):
150150
entries, readme = self.get_commit_data(
151151
"5652ef8bf0d617a3d4085429f4d39007b44ef09d"
152152
)
153-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
154-
tweet = tweet_commit.format_tweet_msg(
153+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
154+
tweet = post_commit.format_post_msg(
155155
section,
156156
entries[0]["title"],
157157
entries[0]["url"],
@@ -194,15 +194,15 @@ def test_multiple_entries(self):
194194
entries, readme = self.get_commit_data(
195195
"749861108e6f65751c4ec0927ef40d495e56dad5"
196196
)
197-
section_0 = tweet_commit.get_entry_section(readme, entries[0]["entry"])
198-
tweet_0 = tweet_commit.format_tweet_msg(
197+
section_0 = post_commit.get_entry_section(readme, entries[0]["entry"])
198+
tweet_0 = post_commit.format_post_msg(
199199
section_0,
200200
entries[0]["title"],
201201
entries[0]["url"],
202202
entries[0]["description"],
203203
)
204-
section_1 = tweet_commit.get_entry_section(readme, entries[1]["entry"])
205-
tweet_1 = tweet_commit.format_tweet_msg(
204+
section_1 = post_commit.get_entry_section(readme, entries[1]["entry"])
205+
tweet_1 = post_commit.format_post_msg(
206206
section_1,
207207
entries[1]["title"],
208208
entries[1]["url"],
@@ -244,8 +244,8 @@ def test_editing_an_entry(self):
244244
entries, readme = self.get_commit_data(
245245
"76deb0040093492197732ba1839ba52beb2e70fc"
246246
)
247-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
248-
tweet = tweet_commit.format_tweet_msg(
247+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
248+
tweet = post_commit.format_post_msg(
249249
section,
250250
entries[0]["title"],
251251
entries[0]["url"],
@@ -271,8 +271,8 @@ def test_moving_an_entry(self):
271271
entries, readme = self.get_commit_data(
272272
"a05ffd323e0cce48119ba78a35478fd18dee359c"
273273
)
274-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
275-
tweet = tweet_commit.format_tweet_msg(
274+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
275+
tweet = post_commit.format_post_msg(
276276
section,
277277
entries[0]["title"],
278278
entries[0]["url"],
@@ -296,7 +296,7 @@ def test_moving_an_entry(self):
296296
def test_msg_format_max_length(self):
297297
"""Check that tweet formatting keeps the max characters permitted."""
298298
# 280 characters total, 23 for the shortned URL, 5 characters formating
299-
tweet = tweet_commit.format_tweet_msg(
299+
tweet = post_commit.format_post_msg(
300300
"s" * 9, "t" * 12, "u" * 23, ("d" * 230) + "."
301301
)
302302

@@ -318,7 +318,7 @@ def test_msg_format_over_length(self):
318318
truncates the text to nearest word.
319319
"""
320320
# 280 characters total, 23 for the shortned URL, 4 characters formating
321-
tweet = tweet_commit.format_tweet_msg(
321+
tweet = post_commit.format_post_msg(
322322
"s" * 9, "t" * 12, "u" * 23, "dd " * 1000
323323
)
324324

@@ -339,8 +339,8 @@ def test_long_tweet(self):
339339
entries, readme = self.get_commit_data(
340340
"8e74b6730578c24c650b375f9490a08eb7d42bdf"
341341
)
342-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
343-
tweet = tweet_commit.format_tweet_msg(
342+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
343+
tweet = post_commit.format_post_msg(
344344
section,
345345
entries[0]["title"],
346346
entries[0]["url"],
@@ -374,8 +374,8 @@ def test_commit_replace_microbit_1(self):
374374
entries, readme = self.get_commit_data(
375375
"efeffb853b72a6df40cb2a0dad45c1b3384aba2f"
376376
)
377-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
378-
tweet = tweet_commit.format_tweet_msg(
377+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
378+
tweet = post_commit.format_post_msg(
379379
section,
380380
entries[0]["title"],
381381
entries[0]["url"],
@@ -405,8 +405,8 @@ def test_commit_replace_microbit_2(self):
405405
entries, readme = self.get_commit_data(
406406
"10d7622864d9dd6cdd81546e3514bfc945af7396"
407407
)
408-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
409-
tweet = tweet_commit.format_tweet_msg(
408+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
409+
tweet = post_commit.format_post_msg(
410410
section,
411411
entries[0]["title"],
412412
entries[0]["url"],
@@ -434,8 +434,8 @@ def test_commit_replace_python(self):
434434
entries, readme = self.get_commit_data(
435435
"67fb7bcb010e62982201c2c365028586e14fab70"
436436
)
437-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
438-
tweet = tweet_commit.format_tweet_msg(
437+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
438+
tweet = post_commit.format_post_msg(
439439
section,
440440
entries[0]["title"],
441441
entries[0]["url"],
@@ -465,8 +465,8 @@ def test_commit_replace_micropython_and_scratch(self):
465465
entries, readme = self.get_commit_data(
466466
"b7a6767a088a47450019c5cacf9469533a087efa"
467467
)
468-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
469-
tweet = tweet_commit.format_tweet_msg(
468+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
469+
tweet = post_commit.format_post_msg(
470470
section,
471471
entries[0]["title"],
472472
entries[0]["url"],
@@ -494,8 +494,8 @@ def test_commit_replace_micropython_2(self):
494494
entries, readme = self.get_commit_data(
495495
"96e29b83d0c7ee1c0e387a2c06aea06bf1ad8929"
496496
)
497-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
498-
tweet = tweet_commit.format_tweet_msg(
497+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
498+
tweet = post_commit.format_post_msg(
499499
section,
500500
entries[0]["title"],
501501
entries[0]["url"],
@@ -520,8 +520,8 @@ def test_commit_replace_raspberry_pi(self):
520520
entries, readme = self.get_commit_data(
521521
"e767f02151131335392957c5cf6038df9deffc6f"
522522
)
523-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
524-
tweet = tweet_commit.format_tweet_msg(
523+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
524+
tweet = post_commit.format_post_msg(
525525
section,
526526
entries[0]["title"],
527527
entries[0]["url"],
@@ -551,8 +551,8 @@ def test_commit_replace_arduino(self):
551551
entries, readme = self.get_commit_data(
552552
"ac8791c560dcfffdfa80fc09dfa218556c98bebe"
553553
)
554-
section = tweet_commit.get_entry_section(readme, entries[1]["entry"])
555-
tweet = tweet_commit.format_tweet_msg(
554+
section = post_commit.get_entry_section(readme, entries[1]["entry"])
555+
tweet = post_commit.format_post_msg(
556556
section,
557557
entries[1]["title"],
558558
entries[1]["url"],
@@ -580,8 +580,8 @@ def test_commit_replace_makecode_1(self):
580580
entries, readme = self.get_commit_data(
581581
"7014b106374048fc18bb1604673e07c8208c6bc3"
582582
)
583-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
584-
tweet = tweet_commit.format_tweet_msg(
583+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
584+
tweet = post_commit.format_post_msg(
585585
section,
586586
entries[0]["title"],
587587
entries[0]["url"],
@@ -607,8 +607,8 @@ def test_commit_replace_makecode_2(self):
607607
entries, readme = self.get_commit_data(
608608
"b0bb85c5d2477100e34e53c5662acc71867bf6d0"
609609
)
610-
section = tweet_commit.get_entry_section(readme, entries[0]["entry"])
611-
tweet = tweet_commit.format_tweet_msg(
610+
section = post_commit.get_entry_section(readme, entries[0]["entry"])
611+
tweet = post_commit.format_post_msg(
612612
section,
613613
entries[0]["title"],
614614
entries[0]["url"],

0 commit comments

Comments
 (0)