evolix/evomaintenance
21
0
Fork 0
Code Issues 10 Pull requests 2 Releases 6 Wiki Activity

Add options to enable/disable hooks (sending mail, commit /etc/.git, save to database…) #7

Merged
jlecour merged 61 commits from options into master 2019-03-26 15:14:12 +01:00
Conversation 7 Commits 61 Files changed 9 +614 -178
jlecour commented 2019-03-07 23:34:19 +01:00
Owner
Copy link

With a few options we can choose (from configuration or on-the-fly) :

  • HOOK_MAIL=<0|1> or --[no-]mail : send an email, or not
  • HOOK_DB=<0|1> or --[no-]db : save log in the database, or not
  • HOOK_COMMIT=<0|1> or --[no-]commit : commit repository changes, or not
  • DRY_RUN=<0|1> or -n|--dry-run : execute no hooks, but prit the options values
With a few options we can choose (from configuration or on-the-fly) : * `HOOK_MAIL=<0|1>` or `--[no-]mail` : send an email, or not * `HOOK_DB=<0|1>` or `--[no-]db` : save log in the database, or not * `HOOK_COMMIT=<0|1>` or `--[no-]commit` : commit repository changes, or not * `DRY_RUN=<0|1>` or `-n|--dry-run` : execute no hooks, but prit the options values
jlecour commented 2019-03-07 23:38:02 +01:00
Author
Owner
Copy link

I also want to change the prompt of the interactive mode to ask if hooks must be skipped or not, but I don't have any idea how yet.

I also want to change the prompt of the interactive mode to ask if hooks must be skipped or not, but I don't have any idea how yet.
jlecour commented 2019-03-09 21:07:34 +01:00
Author
Owner
Copy link

I've figured it out 🎉

First we need to find out if the script is run in interactive mode or not.

If not, we just apply the options for the hooks.
If yes, each hook asks a question to run it or not. The default value is implied by the option.

I've also added a verbose mode to show the content of the mail, the DB query and the repositories diffs.
The "dry run" mode becomes silent. It "just" removes the hook execution.
The two of them applied together is useful to verify the general behaviour of the script without changing anything on the host.

I'm very satisfied with how it turned out.
Now I need to do a lot of testing on many Debian ans OpenBSD versions.

I've figured it out :tada: First we need to find out if the script is run in interactive mode or not. If not, we just apply the options for the hooks. If yes, each hook asks a question to run it or not. The default value is implied by the option. I've also added a verbose mode to show the content of the mail, the DB query and the repositories diffs. The "dry run" mode becomes silent. It "just" removes the hook execution. The two of them applied together is useful to verify the general behaviour of the script without changing anything on the host. I'm very satisfied with how it turned out. Now I need to do a lot of testing on many Debian ans OpenBSD versions.
jlecour commented 2019-03-09 22:06:26 +01:00
Author
Owner
Copy link

Now we can also customize the mail recipient on the fly!

Now we can also customize the mail recipient on the fly!
jlecour commented 2019-03-10 00:44:47 +01:00
Author
Owner
Copy link

I've added --version and --help options.
The help message gives a lot of informations, almost like a man page.

I've also improved the POSIX compatibility.

I've added `--version` and `--help` options. The help message gives a lot of informations, almost like a man page. I've also improved the POSIX compatibility.
jlecour commented 2019-03-12 16:28:24 +01:00
Author
Owner
Copy link

As discussed AFK, we'll explore a few changes :

  • display git statuses before typing the message
  • add the timezone of the server in the metadata
  • execute evocheck (if present) and display results
  • add the maintenance message to /etc/motd (keep the last few only)
  • execute the DB hook after the mail hook
  • add an "auto" mode to have only one keystroke in most cases
As discussed AFK, we'll explore a few changes : * [x] display git statuses before typing the message * [ ] add the timezone of the server in the metadata * [x] execute evocheck (if present) and display results * [ ] add the maintenance message to `/etc/motd` (keep the last few only) * [x] execute the DB hook after the mail hook * [x] add an "auto" mode to have only one keystroke in most cases
Ghost commented 2019-03-12 18:30:23 +01:00
First-time contributor
Copy link

We also talked about removing the copyright notice from --help and keeping it in --version instead. As well as removing the version number from --help.

I will create an issue for the man(1) page.

We also talked about removing the copyright notice from --help and keeping it in --version instead. As well as removing the version number from --help. I will create an issue for the man(1) page.
👍 1
jlecour commented 2019-03-15 14:10:58 +01:00
Author
Owner
Copy link

new things to do :

  • verify that it works in auto mode from cron
  • display more Git information
  • add options values + actual email address to the log file
  • switch the project to public visibility
new things to do : * [x] verify that it works in auto mode from cron * [x] display more Git information * [x] add options values + actual email address to the log file * [x] switch the project to public visibility
jlecour changed title from WIP: Add options to enable/disable hooks (sending mail, commit /etc/.git, save to database…) to Add options to enable/disable hooks (sending mail, commit /etc/.git, save to database…) 2019-03-26 15:12:37 +01:00
jlecour closed this pull request 2019-03-26 15:14:12 +01:00
jlecour deleted branch options 2019-03-26 15:29:30 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
help wanted

Need some help

  
invalid

Something is wrong

  
question

More information is needed

  
wontfix

This won't be fixed

No labels
bug
duplicate
enhancement
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: evolix/evomaintenance#7
No description provided.
Delete branch "options"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?