Update the bot and refactor files #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changes in detail:
1. Switch to Python 3.
2. Rename `post_comment.py` to `tldr_bot.py`.
3. Change main endpoint from `/` to `/comment` (old one is still
kept for compatibility, will be removed once we update the
travis scripts on the pages repo).
4. Add new endpoint `/comment/once` which does the same as
`/comment`, but first checks if `tldr-bot` hasn't already
commented on the PR.
5. Rename the `/test` endpoint to `/status`.
6. Change HTTP response code for malformed request from 500 (server
error) to 400 (client error).
7. Remove the unneeded `GITHUB_URL` environment variable.
8. Refactor code (reorder imports, indentation, spacing, etc.)
Changes in detail:
1. Change script name to `tldr_bot.py`.
2. Remove unneeded `GITHUB_URL` and `APP_ROOT` environment
variables.
3. Overall refactor: wording, formatting, etc.
Changes in detail:
1. Change script name to `tldr_bot.py`.
2. Add `Wants=` and `After=` directives to start the service after
the network is online.
3. Add recommended `User=` and `Group=` directives to run the
as a specific user different than `root`.
4. Reorder fields in order of importance.
|
@tldr-bot is now running the latest code from this branch. |
sbrl
reviewed
Nov 16, 2019
sbrl
approved these changes
Nov 17, 2019
|
Let's merge this ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
So... not really a big change, just a bunch of little changes.
The main point of this PR is to update the bot to add a new endpoint that checks if a comment was already made on the PR before posting a new one. This will be helpful when adding the checking functionality in the main repo which checks if pages of a PR are already present or duplicated. To notify the author, the bot needs to comment only once when the PR is created, not every single time a commit is pushed to the PR (that functionality is still there of course since it's needed for build errors, just on a different endpoint).
Detailed list of changes (also available in the commit messages):
Changes to the Python script:
post_comment.pytotldr_bot.py./to/comment(old one is still kept for compatibility, will be removed once we update the travis scripts on the pages repo)./comment/oncewhich does the same as/comment, but first checks iftldr-bothasn't already commented on the PR./testendpoint to/status.GITHUB_URLenvironment variable.Changes to the systemd
.servicefile:tldr_bot.py.Wants=andAfter=directives to start the service after the network is online.User=andGroup=directives to run as a specific user different thanroot.Changes to
README.md:tldr_bot.py.GITHUB_URLandAPP_ROOTenvironment variables.PS: I have no Idea why GitHub is using lowercase Roman numerals for the secodnary list elements, LOL. Hope it's still clear.