Skip to content

Add optional TRIGGERED_BY_EMAIL to mention who triggered the build #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AndreiHippo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add optional TRIGGERED_BY_EMAIL to mention who triggered the build #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Configuration is done via env variables
* `SLACK_BOT_TOKEN` - Slack bot token. Mandatory parameter. scopes: channels:history, chat:write, reactions:read, users:read.email, users:read
* `SLACK_APP_TOKEN` - Slack app token. Mandatory parameter. scopes: connections:write
* `SLACK_CHANNEL_NAME` - Slack channel name. Also channel_id can be used
* `TRIGGERED_BY_EMAIL` - Email of the person who triggered the build, for example by pressing the merge button. Optional parameter. When set, a `Triggered by` line is added to the approval message, mentioning that person if the email matches a Slack profile. Useful because the commit itself does not always point at a person: squash merges on GitHub, for instance, are committed as `noreply@github.com`

# Slack App manifect example
```yaml
Expand Down
13 changes: 12 additions & 1 deletion main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
timezone = os.environ['TIMEZONE']
production_branches = os.environ['PRODUCTION_BRANCHES'].split()
slack_bot_token = os.environ["SLACK_BOT_TOKEN"]
# Not every commit is made by a person - squash merges, for instance, are committed by
# the SCM itself - so CI can tell us who triggered the build. Optional.
triggered_by_email = os.environ.get('TRIGGERED_BY_EMAIL', '')

print(f'branches_to_promote: {branches_to_promote}')
print(f'production_branches: {production_branches}')
Expand All @@ -40,6 +43,11 @@
author_email = helpers_git.get_author_email_for_ref(current_commit_id)
author_slack_id = helpers_slack.user_id_by_email(app, author_email)
author_id = f'<@{author_slack_id}>' if author_slack_id is not None else author_email
triggered_by_id = None
if triggered_by_email:
triggered_by_slack_id = helpers_slack.user_id_by_email(app, triggered_by_email)
triggered_by_id = (f'<@{triggered_by_slack_id}>'
if triggered_by_slack_id is not None else triggered_by_email)
commit_msg = helpers_git.get_commit_message_for_ref(current_commit_id)

text_for_request = 'If approved will promote commit(s) below to branch '
Expand All @@ -49,7 +57,10 @@
details += f'Commit message: `{commit_msg}`\n'
details += f'Commit id: `{current_commit_id}`\n'
details += f'Committer: {commiter_id}\n'
details += f'Author: {author_id}\n\n'
details += f'Author: {author_id}\n'
if triggered_by_id is not None:
details += f'Triggered by: {triggered_by_id}\n'
details += '\n'
details += helpers_time.generate_time_based_message(production_branches, branches_to_promote, timezone)

# Generate separate diff blocks for every branch
Expand Down