Skip to content

Add ci_activity to email notifications Cc list #4328

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.

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

Merged
merged 3 commits into from
Mar 29, 2021
Merged

Add ci_activity to email notifications Cc list #4328

merged 3 commits into from
Mar 29, 2021

Conversation

Rylan12
Copy link
Contributor

@Rylan12 Rylan12 commented Mar 6, 2021

Why:

Closes #4327

The Filtering email notifications section of the Configuring notifications documentation lists the ways in which GitHub includes notification metadata in notification emails. Part of that metadata is the Cc field which includes a reason why the user is receiving the email.

Currently, email notifications about completed action runs are sent with ci_activity@noreply.github.com in the Cc field. This is not documented here, so I believe it should be added.

What's being changed:

I've added the following element to the Cc row in the table:

  • ci_activity: An action run that you initiated finished.

I'm not completely sure about the wording here. I chose not to use the GitHub Actions product name because this is referring to an instance of a GitHub Actions "thing". I also wasn't sure if "action run" is necessary or simply "action" is sufficient. I'll differ to you for the specific terminology that should be used (e.g. workflow, action, ci run, etc.)

Also, as noted in #4327, I don't know if the wording should be modified to not be exclusive to GitHub Actions CI. If non-GHA CI would also trigger these notifications, it may make more sense to use generic wording such as:

  • ci_activity: A CI run that you initiated finished.

Check off the following:

@welcome
Copy link

welcome bot commented Mar 6, 2021

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions
Copy link
Contributor

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Mar 14, 2021
@Rylan12
Copy link
Contributor Author

Rylan12 commented Mar 14, 2021

As this PR hasn't yet been reviewed, I'd like it to remain open.

@github-actions github-actions bot removed the stale There is no recent activity on this issue or pull request label Mar 15, 2021
@janiceilene janiceilene added the notifications Content related to notifications label Mar 16, 2021
@janiceilene
Copy link
Contributor

@Rylan12 Thanks so much for opening a PR! I'll get this triaged for review ✨ Sorry about the delay, I was out last week 💛

@janiceilene janiceilene added the waiting for review Issue/PR is waiting for a writer's review label Mar 16, 2021
@lucascosti lucascosti self-assigned this Mar 29, 2021
Copy link
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for this contribution, @Rylan12! 🙇‍♂️

I made an edit to add versioning for the products that GitHub Actions is in, as well as our terminology (workflow run).

I don't know if the wording should be modified to not be exclusive to GitHub Actions CI. If non-GHA CI would also trigger these notifications, it may make more sense to use generic wording

I'm 90% sure that this notification is only for GitHub Actions 👍

I'll get it merged in! 🎉

@lucascosti lucascosti merged commit d82d2fa into github:main Mar 29, 2021
@github-actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@1SatoshiNakamoto

This comment has been minimized.

@1SatoshiNakamoto

This comment has been minimized.

@Rylan12 Rylan12 deleted the patch-1 branch March 29, 2021 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notifications Content related to notifications waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ci_activity to email notifications Cc list
4 participants