pegleg/doc/source/exceptions.rst
Felipe Monteiro 5369efeec1 git: Raise exception on ref checkout from dirty repo
This raises an exception on trying to checkout a ref from a
dirty repo in the git_handler module. The parent patch
https://review.openstack.org/#/c/582652/ currently forcibly
cleans the repo but this is undesirable as it may have local
user changes that need to be resolved first.

The safest path is for Pegleg to immediately raise an exception
on any tracked/untracked files that are detected using the
GitPython API.

Unit tests are added for both untracked/tracked file cases.

Change-Id: I2241bc981dca1999508c3c7e95948fe47a5ddebf
2018-07-24 18:58:09 +00:00

73 lines
2.0 KiB
ReStructuredText

..
Copyright 2018 AT&T Intellectual Property.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Pegleg Exceptions
==================
Base Exceptions
---------------
.. list-table::
:widths: 5 50
:header-rows: 1
* - Exception Name
- Description
* - PeglegBaseException
- .. autoexception:: pegleg.engine.exceptions.PeglegBaseException
:members:
:undoc-members:
Git Exceptions
--------------
.. list-table::
:widths: 5 50
:header-rows: 1
* - Exception Name
- Description
* - BaseGitException
- .. autoexception:: pegleg.engine.exceptions.BaseGitException
:members:
:show-inheritance:
:undoc-members:
* - GitDirtyRepoException
- .. autoexception:: pegleg.engine.exceptions.GitDirtyRepoException
:members:
:show-inheritance:
:undoc-members:
* - GitException
- .. autoexception:: pegleg.engine.exceptions.GitException
:members:
:show-inheritance:
:undoc-members:
* - GitAuthException
- .. autoexception:: pegleg.engine.exceptions.GitAuthException
:members:
:show-inheritance:
:undoc-members:
* - GitProxyException
- .. autoexception:: pegleg.engine.exceptions.GitProxyException
:members:
:show-inheritance:
:undoc-members:
* - GitSSHException
- .. autoexception:: pegleg.engine.exceptions.GitSSHException
:members:
:show-inheritance:
:undoc-members: