You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

Tool:Asanack-bot: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>Majavah
 
imported>Samuel (WMF)
Line 10: Line 10:


== Maintenance ==
== Maintenance ==
To manage the tool, you'll need to have a [[Help:Create a Wikimedia developer account|Wikimedia Developer Account]] and be added [[Portal:Toolforge/Tool Accounts#Maintainers|as a maintainer]].


=== Login ===
=== Prerequisites ===
To manage the tool, you'll need:
 
# a Wikimedia Developer Account. Please create one by following the instructions on [[Help:Create a Wikimedia developer account]].
#to be [[Portal:Toolforge/Tool Accounts#Maintainers|a maintainer]] of the asanack-bot. Please reach out to the [[m:Trust and Safety|Trust & Safety team]] to request maintainer privilege.
 
===Login===
<pre>
<pre>
$ ssh login.toolforge.org
$ ssh login.toolforge.org
Line 18: Line 23:
</pre>
</pre>


=== Updating or stopping the bot ===
===Update or stop the bot ===
<syntaxhighlight lang="sh">
<syntaxhighlight lang="sh">
# Update bot to latest version
# Update bot to latest version
Line 31: Line 36:
</syntaxhighlight>
</syntaxhighlight>


{{lowercase}}
=== Change bot parameters ===
Parameters such as the Slack channel ID or Asana project ID are defined in an environment file <code>.env</code> only accessible to maintainers.
 
After logging into the server, one can apply the desired change through the command line editor<syntaxhighlight lang="sh">
# Edit .env file
$ vi www/python/src/.env
 
</syntaxhighlight>After making the appropriate changes, it is important to restart the bot for changes to take effect.<syntaxhighlight lang="sh">
# Restart the bot
$ ./engine.sh restart
</syntaxhighlight>{{lowercase}}
[[Category:Bots]]
[[Category:Bots]]

Revision as of 12:48, 24 August 2022

Toolforge tools
Crystal Clear app package utilities.png asanack-bot
Description A Foundation's internal tool for Asana & Slack Integration
Keywords asana, slack, python
Author(s) Samuel (WMF)
Maintainer(s) (View all)
Source code Gitlab
License MIT License

Maintenance

Prerequisites

To manage the tool, you'll need:

  1. a Wikimedia Developer Account. Please create one by following the instructions on Help:Create a Wikimedia developer account.
  2. to be a maintainer of the asanack-bot. Please reach out to the Trust & Safety team to request maintainer privilege.

Login

$ ssh login.toolforge.org
$ become asanack-bot

Update or stop the bot

# Update bot to latest version
$ ./engine.sh update

# Stop the bot
$ ./engine.sh stop

# Restart the bot
$ ./engine.sh restart

Change bot parameters

Parameters such as the Slack channel ID or Asana project ID are defined in an environment file .env only accessible to maintainers.

After logging into the server, one can apply the desired change through the command line editor

# Edit .env file
$ vi www/python/src/.env

After making the appropriate changes, it is important to restart the bot for changes to take effect.

# Restart the bot
$ ./engine.sh restart