Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Slight reorganization

Browse source
This commit is contained in:
Wendy Wang 2022-10-06 11:46:55 +02:00
parent 1de1625aae
commit 1701539454
1 changed files with 34 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

63
evennia/contrib/utils/git/git_integration.py
View file

@ -7,12 +7,30 @@ from evennia.server.sessionhandler import SESSIONS
import git import git
import datetime import datetime
class CmdGit(MuxCommand):
"""
Pull the latest code from your repository or checkout a different branch.
class GitCommand(MuxCommand): Usage:
""" git status - View an overview of your git repository.
Parent class for Git commands. git branch - View available branches.
git checkout main - Checkout the main branch of your code.
git pull - Pull the latest code from your current branch.
For updating evennia code, the same commands are available with 'git evennia':
git evennia status
git evennia branch
git evennia checkout <branch>
git evennia pull
If there are any conflicts encountered, the command will abort. The command will reload your game after pulling new code automatically, but for changes involving persistent scripts etc, you may need to manually restart.
""" """
key = "@git"
aliases = ["@git evennia"]
locks = "cmd:pperm(Developer)"
help_category = "System"
def parse(self): def parse(self):
""" """
Parse the arguments and ensure git repositories exist. Fail with InterruptCommand if git repositories not found. Parse the arguments and ensure git repositories exist. Fail with InterruptCommand if git repositories not found.
@ -59,33 +77,11 @@ class GitCommand(MuxCommand):
""" """
short_sha = repo.git.rev_parse(hexsha, short=True) short_sha = repo.git.rev_parse(hexsha, short=True)
return short_sha return short_sha
class CmdGit(GitCommand):
"""
Pull the latest code from your repository or checkout a different branch.
Usage:
git status - View an overview of your git repository.
git branch - View available branches.
git checkout main - Checkout the main branch of your code.
git pull - Pull the latest code from your current branch.
For updating evennia code, the same commands are available with 'git evennia':
git evennia status
git evennia branch
git evennia checkout <branch>
git evennia pull
If there are any conflicts encountered, the command will abort. The command will reload your game after pulling new code automatically, but for changes involving persistent scripts etc, you may need to manually restart.
"""
key = "@git"
aliases = ["@git evennia"]
locks = "cmd:pperm(Developer)"
help_category = "System"
def get_status(self): def get_status(self):
"""
Retrieves the status of the active git repository, displaying unstaged changes/untracked files.
"""
time_of_commit = datetime.datetime.fromtimestamp(self.commit.committed_date) time_of_commit = datetime.datetime.fromtimestamp(self.commit.committed_date)
status_msg = '\n'.join([f"Branch: |w{self.branch}|n ({self.repo.git.rev_parse(self.commit.hexsha, short=True)}) ({time_of_commit})", status_msg = '\n'.join([f"Branch: |w{self.branch}|n ({self.repo.git.rev_parse(self.commit.hexsha, short=True)}) ({time_of_commit})",
f"By {self.commit.author.email}: {self.commit.message}"]) f"By {self.commit.author.email}: {self.commit.message}"])
@ -98,11 +94,17 @@ class CmdGit(GitCommand):
return status_msg return status_msg
def get_branches(self): def get_branches(self):
"""
Display current and available branches.
"""
remote_refs = self.repo.remote().refs remote_refs = self.repo.remote().refs
branch_msg = f"Current branch: |w{self.branch}|n. Branches available: {list_to_string(remote_refs)}" branch_msg = f"Current branch: |w{self.branch}|n. Branches available: {list_to_string(remote_refs)}"
return branch_msg return branch_msg
def checkout(self): def checkout(self):
"""
Check out a specific branch.
"""
remote_refs = self.repo.remote().refs remote_refs = self.repo.remote().refs
to_branch = self.args.strip().removeprefix('origin/') # Slightly hacky, but git tacks on the origin/ to_branch = self.args.strip().removeprefix('origin/') # Slightly hacky, but git tacks on the origin/
@ -122,6 +124,9 @@ class CmdGit(GitCommand):
return True return True
def pull(self): def pull(self):
"""
Attempt to pull new code.
"""
old_commit = self.commit old_commit = self.commit
try: try:
self.repo.remotes.origin.pull() self.repo.remotes.origin.pull()
@ -159,7 +164,7 @@ class CmdGit(GitCommand):
# CmdSet for easily install all commands # CmdSet for easily install all commands
class GitCmdSet(CmdSet): class GitCmdSet(CmdSet):
""" """
The map command. The git command.
""" """
def at_cmdset_creation(self): def at_cmdset_creation(self):