* Add API for manipulating Git hooks Signed-off-by: Segev Finer <segev@codeocean.com> * Replace code.gitea.io/sdk with PR branch temporarily for CI * Switch back to code.gitea.io/sdk@master * Return 403 instead of 404 on no permission to edit hooks in API * Add tests for Git hooks API * Update models/repo_list_test.go Co-Authored-By: segevfiner <segev208@gmail.com> * Update models/repo_list_test.go Co-Authored-By: segevfiner <segev208@gmail.com> * empty linetags/v1.9.0-rc1
go 1.12 | go 1.12 | ||||
require ( | require ( | ||||
code.gitea.io/sdk v0.0.0-20190321154058-a669487e86e0 | |||||
code.gitea.io/sdk v0.0.0-20190416172854-7d954d775498 | |||||
github.com/BurntSushi/toml v0.3.1 // indirect | github.com/BurntSushi/toml v0.3.1 // indirect | ||||
github.com/PuerkitoBio/goquery v0.0.0-20170324135448-ed7d758e9a34 | github.com/PuerkitoBio/goquery v0.0.0-20170324135448-ed7d758e9a34 | ||||
github.com/RoaringBitmap/roaring v0.4.7 // indirect | github.com/RoaringBitmap/roaring v0.4.7 // indirect |
cloud.google.com/go v0.30.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= | cloud.google.com/go v0.30.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw= | ||||
code.gitea.io/sdk v0.0.0-20190321154058-a669487e86e0 h1:pIKKrTUox+0pGcZwFl19Glw9gKfoeNkA02EqeiSmLjs= | |||||
code.gitea.io/sdk v0.0.0-20190321154058-a669487e86e0/go.mod h1:5bZt0dRznpn2JysytQnV0yCru3FwDv9O5G91jo+lDAk= | |||||
code.gitea.io/sdk v0.0.0-20190416172854-7d954d775498 h1:rcjwXMYIjYts88akPiyy/GB+imecpf159jojChciEEw= | |||||
code.gitea.io/sdk v0.0.0-20190416172854-7d954d775498/go.mod h1:5bZt0dRznpn2JysytQnV0yCru3FwDv9O5G91jo+lDAk= | |||||
github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ= | github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ= | ||||
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= | github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= | ||||
github.com/PuerkitoBio/goquery v0.0.0-20170324135448-ed7d758e9a34 h1:UsHpWO0Elp6NaWVARdZHjiYwkhrspHVEGsyIKPb9OI8= | github.com/PuerkitoBio/goquery v0.0.0-20170324135448-ed7d758e9a34 h1:UsHpWO0Elp6NaWVARdZHjiYwkhrspHVEGsyIKPb9OI8= |
// Copyright 2019 The Gitea Authors. All rights reserved. | |||||
// Use of this source code is governed by a MIT-style | |||||
// license that can be found in the LICENSE file. | |||||
package integrations | |||||
import ( | |||||
"fmt" | |||||
"net/http" | |||||
"testing" | |||||
"code.gitea.io/gitea/models" | |||||
api "code.gitea.io/sdk/gitea" | |||||
"github.com/stretchr/testify/assert" | |||||
) | |||||
const testHookContent = `#!/bin/bash | |||||
echo Hello, World! | |||||
` | |||||
func TestAPIListGitHooks(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 37}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
// user1 is an admin user | |||||
session := loginUser(t, "user1") | |||||
token := getTokenForLoggedInUser(t, session) | |||||
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
resp := MakeRequest(t, req, http.StatusOK) | |||||
var apiGitHooks []*api.GitHook | |||||
DecodeJSON(t, resp, &apiGitHooks) | |||||
assert.Len(t, apiGitHooks, 3) | |||||
for _, apiGitHook := range apiGitHooks { | |||||
if apiGitHook.Name == "pre-receive" { | |||||
assert.True(t, apiGitHook.IsActive) | |||||
assert.Equal(t, testHookContent, apiGitHook.Content) | |||||
} else { | |||||
assert.False(t, apiGitHook.IsActive) | |||||
assert.Empty(t, apiGitHook.Content) | |||||
} | |||||
} | |||||
} | |||||
func TestAPIListGitHooksNoHooks(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
// user1 is an admin user | |||||
session := loginUser(t, "user1") | |||||
token := getTokenForLoggedInUser(t, session) | |||||
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
resp := MakeRequest(t, req, http.StatusOK) | |||||
var apiGitHooks []*api.GitHook | |||||
DecodeJSON(t, resp, &apiGitHooks) | |||||
assert.Len(t, apiGitHooks, 3) | |||||
for _, apiGitHook := range apiGitHooks { | |||||
assert.False(t, apiGitHook.IsActive) | |||||
assert.Empty(t, apiGitHook.Content) | |||||
} | |||||
} | |||||
func TestAPIListGitHooksNoAccess(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
session := loginUser(t, owner.Name) | |||||
token := getTokenForLoggedInUser(t, session) | |||||
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
MakeRequest(t, req, http.StatusForbidden) | |||||
} | |||||
func TestAPIGetGitHook(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 37}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
// user1 is an admin user | |||||
session := loginUser(t, "user1") | |||||
token := getTokenForLoggedInUser(t, session) | |||||
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
resp := MakeRequest(t, req, http.StatusOK) | |||||
var apiGitHook *api.GitHook | |||||
DecodeJSON(t, resp, &apiGitHook) | |||||
assert.True(t, apiGitHook.IsActive) | |||||
assert.Equal(t, testHookContent, apiGitHook.Content) | |||||
} | |||||
func TestAPIGetGitHookNoAccess(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
session := loginUser(t, owner.Name) | |||||
token := getTokenForLoggedInUser(t, session) | |||||
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
MakeRequest(t, req, http.StatusForbidden) | |||||
} | |||||
func TestAPIEditGitHook(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
// user1 is an admin user | |||||
session := loginUser(t, "user1") | |||||
token := getTokenForLoggedInUser(t, session) | |||||
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
req := NewRequestWithJSON(t, "PATCH", urlStr, &api.EditGitHookOption{ | |||||
Content: testHookContent, | |||||
}) | |||||
resp := MakeRequest(t, req, http.StatusOK) | |||||
var apiGitHook *api.GitHook | |||||
DecodeJSON(t, resp, &apiGitHook) | |||||
assert.True(t, apiGitHook.IsActive) | |||||
assert.Equal(t, testHookContent, apiGitHook.Content) | |||||
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
resp = MakeRequest(t, req, http.StatusOK) | |||||
var apiGitHook2 *api.GitHook | |||||
DecodeJSON(t, resp, &apiGitHook2) | |||||
assert.True(t, apiGitHook2.IsActive) | |||||
assert.Equal(t, testHookContent, apiGitHook2.Content) | |||||
} | |||||
func TestAPIEditGitHookNoAccess(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
session := loginUser(t, owner.Name) | |||||
token := getTokenForLoggedInUser(t, session) | |||||
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
req := NewRequestWithJSON(t, "PATCH", urlStr, &api.EditGitHookOption{ | |||||
Content: testHookContent, | |||||
}) | |||||
MakeRequest(t, req, http.StatusForbidden) | |||||
} | |||||
func TestAPIDeleteGitHook(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 37}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
// user1 is an admin user | |||||
session := loginUser(t, "user1") | |||||
token := getTokenForLoggedInUser(t, session) | |||||
req := NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
MakeRequest(t, req, http.StatusNoContent) | |||||
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
resp := MakeRequest(t, req, http.StatusOK) | |||||
var apiGitHook2 *api.GitHook | |||||
DecodeJSON(t, resp, &apiGitHook2) | |||||
assert.False(t, apiGitHook2.IsActive) | |||||
assert.Empty(t, apiGitHook2.Content) | |||||
} | |||||
func TestAPIDeleteGitHookNoAccess(t *testing.T) { | |||||
prepareTestEnv(t) | |||||
repo := models.AssertExistsAndLoadBean(t, &models.Repository{ID: 1}).(*models.Repository) | |||||
owner := models.AssertExistsAndLoadBean(t, &models.User{ID: repo.OwnerID}).(*models.User) | |||||
session := loginUser(t, owner.Name) | |||||
token := getTokenForLoggedInUser(t, session) | |||||
req := NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s", | |||||
owner.Name, repo.Name, token) | |||||
MakeRequest(t, req, http.StatusForbidden) | |||||
} |
expectedResults | expectedResults | ||||
}{ | }{ | ||||
{name: "RepositoriesMax50", requestURL: "/api/v1/repos/search?limit=50", expectedResults: expectedResults{ | {name: "RepositoriesMax50", requestURL: "/api/v1/repos/search?limit=50", expectedResults: expectedResults{ | ||||
nil: {count: 20}, | |||||
user: {count: 20}, | |||||
user2: {count: 20}}, | |||||
nil: {count: 21}, | |||||
user: {count: 21}, | |||||
user2: {count: 21}}, | |||||
}, | }, | ||||
{name: "RepositoriesMax10", requestURL: "/api/v1/repos/search?limit=10", expectedResults: expectedResults{ | {name: "RepositoriesMax10", requestURL: "/api/v1/repos/search?limit=10", expectedResults: expectedResults{ | ||||
nil: {count: 10}, | nil: {count: 10}, |
ref: refs/heads/master |
[core] | |||||
repositoryformatversion = 0 | |||||
filemode = true | |||||
bare = true |
Unnamed repository; edit this file 'description' to name the repository. |
#!/bin/sh | |||||
# | |||||
# An example hook script to check the commit log message taken by | |||||
# applypatch from an e-mail message. | |||||
# | |||||
# The hook should exit with non-zero status after issuing an | |||||
# appropriate message if it wants to stop the commit. The hook is | |||||
# allowed to edit the commit message file. | |||||
# | |||||
# To enable this hook, rename this file to "applypatch-msg". | |||||
. git-sh-setup | |||||
commitmsg="$(git rev-parse --git-path hooks/commit-msg)" | |||||
test -x "$commitmsg" && exec "$commitmsg" ${1+"$@"} | |||||
: |
#!/bin/sh | |||||
# | |||||
# An example hook script to check the commit log message. | |||||
# Called by "git commit" with one argument, the name of the file | |||||
# that has the commit message. The hook should exit with non-zero | |||||
# status after issuing an appropriate message if it wants to stop the | |||||
# commit. The hook is allowed to edit the commit message file. | |||||
# | |||||
# To enable this hook, rename this file to "commit-msg". | |||||
# Uncomment the below to add a Signed-off-by line to the message. | |||||
# Doing this in a hook is a bad idea in general, but the prepare-commit-msg | |||||
# hook is more suited to it. | |||||
# | |||||
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') | |||||
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" | |||||
# This example catches duplicate Signed-off-by lines. | |||||
test "" = "$(grep '^Signed-off-by: ' "$1" | | |||||
sort | uniq -c | sed -e '/^[ ]*1[ ]/d')" || { | |||||
echo >&2 Duplicate Signed-off-by lines. | |||||
exit 1 | |||||
} |
#!/usr/bin/env bash | |||||
ORI_DIR=`pwd` | |||||
SHELL_FOLDER=$(cd "$(dirname "$0")";pwd) | |||||
cd "$ORI_DIR" | |||||
for i in `ls "$SHELL_FOLDER/post-receive.d"`; do | |||||
sh "$SHELL_FOLDER/post-receive.d/$i" | |||||
done |
#!/usr/bin/env bash | |||||
"$GITEA_ROOT/gitea" hook --config="$GITEA_ROOT/$GITEA_CONF" post-receive |
#!/bin/sh | |||||
# | |||||
# An example hook script to prepare a packed repository for use over | |||||
# dumb transports. | |||||
# | |||||
# To enable this hook, rename this file to "post-update". | |||||
exec git update-server-info |
#!/bin/sh | |||||
# | |||||
# An example hook script to verify what is about to be committed | |||||
# by applypatch from an e-mail message. | |||||
# | |||||
# The hook should exit with non-zero status after issuing an | |||||
# appropriate message if it wants to stop the commit. | |||||
# | |||||
# To enable this hook, rename this file to "pre-applypatch". | |||||
. git-sh-setup | |||||
precommit="$(git rev-parse --git-path hooks/pre-commit)" | |||||
test -x "$precommit" && exec "$precommit" ${1+"$@"} | |||||
: |
#!/bin/sh | |||||
# | |||||
# An example hook script to verify what is about to be committed. | |||||
# Called by "git commit" with no arguments. The hook should | |||||
# exit with non-zero status after issuing an appropriate message if | |||||
# it wants to stop the commit. | |||||
# | |||||
# To enable this hook, rename this file to "pre-commit". | |||||
if git rev-parse --verify HEAD >/dev/null 2>&1 | |||||
then | |||||
against=HEAD | |||||
else | |||||
# Initial commit: diff against an empty tree object | |||||
against=4b825dc642cb6eb9a060e54bf8d69288fbee4904 | |||||
fi | |||||
# If you want to allow non-ASCII filenames set this variable to true. | |||||
allownonascii=$(git config --bool hooks.allownonascii) | |||||
# Redirect output to stderr. | |||||
exec 1>&2 | |||||
# Cross platform projects tend to avoid non-ASCII filenames; prevent | |||||
# them from being added to the repository. We exploit the fact that the | |||||
# printable range starts at the space character and ends with tilde. | |||||
if [ "$allownonascii" != "true" ] && | |||||
# Note that the use of brackets around a tr range is ok here, (it's | |||||
# even required, for portability to Solaris 10's /usr/bin/tr), since | |||||
# the square bracket bytes happen to fall in the designated range. | |||||
test $(git diff --cached --name-only --diff-filter=A -z $against | | |||||
LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 | |||||
then | |||||
cat <<\EOF | |||||
Error: Attempt to add a non-ASCII file name. | |||||
This can cause problems if you want to work with people on other platforms. | |||||
To be portable it is advisable to rename the file. | |||||
If you know what you are doing you can disable this check using: | |||||
git config hooks.allownonascii true | |||||
EOF | |||||
exit 1 | |||||
fi | |||||
# If there are whitespace errors, print the offending file names and fail. | |||||
exec git diff-index --check --cached $against -- |
#!/bin/sh | |||||
# An example hook script to verify what is about to be pushed. Called by "git | |||||
# push" after it has checked the remote status, but before anything has been | |||||
# pushed. If this script exits with a non-zero status nothing will be pushed. | |||||
# | |||||
# This hook is called with the following parameters: | |||||
# | |||||
# $1 -- Name of the remote to which the push is being done | |||||
# $2 -- URL to which the push is being done | |||||
# | |||||
# If pushing without using a named remote those arguments will be equal. | |||||
# | |||||
# Information about the commits which are being pushed is supplied as lines to | |||||
# the standard input in the form: | |||||
# | |||||
# <local ref> <local sha1> <remote ref> <remote sha1> | |||||
# | |||||
# This sample shows how to prevent push of commits where the log message starts | |||||
# with "WIP" (work in progress). | |||||
remote="$1" | |||||
url="$2" | |||||
z40=0000000000000000000000000000000000000000 | |||||
while read local_ref local_sha remote_ref remote_sha | |||||
do | |||||
if [ "$local_sha" = $z40 ] | |||||
then | |||||
# Handle delete | |||||
: | |||||
else | |||||
if [ "$remote_sha" = $z40 ] | |||||
then | |||||
# New branch, examine all commits | |||||
range="$local_sha" | |||||
else | |||||
# Update to existing branch, examine new commits | |||||
range="$remote_sha..$local_sha" | |||||
fi | |||||
# Check for WIP commit | |||||
commit=`git rev-list -n 1 --grep '^WIP' "$range"` | |||||
if [ -n "$commit" ] | |||||
then | |||||
echo >&2 "Found WIP commit in $local_ref, not pushing" | |||||
exit 1 | |||||
fi | |||||
fi | |||||
done | |||||
exit 0 |
#!/bin/sh | |||||
# | |||||
# Copyright (c) 2006, 2008 Junio C Hamano | |||||
# | |||||
# The "pre-rebase" hook is run just before "git rebase" starts doing | |||||
# its job, and can prevent the command from running by exiting with | |||||
# non-zero status. | |||||
# | |||||
# The hook is called with the following parameters: | |||||
# | |||||
# $1 -- the upstream the series was forked from. | |||||
# $2 -- the branch being rebased (or empty when rebasing the current branch). | |||||
# | |||||
# This sample shows how to prevent topic branches that are already | |||||
# merged to 'next' branch from getting rebased, because allowing it | |||||
# would result in rebasing already published history. | |||||
publish=next | |||||
basebranch="$1" | |||||
if test "$#" = 2 | |||||
then | |||||
topic="refs/heads/$2" | |||||
else | |||||
topic=`git symbolic-ref HEAD` || | |||||
exit 0 ;# we do not interrupt rebasing detached HEAD | |||||
fi | |||||
case "$topic" in | |||||
refs/heads/??/*) | |||||
;; | |||||
*) | |||||
exit 0 ;# we do not interrupt others. | |||||
;; | |||||
esac | |||||
# Now we are dealing with a topic branch being rebased | |||||
# on top of master. Is it OK to rebase it? | |||||
# Does the topic really exist? | |||||
git show-ref -q "$topic" || { | |||||
echo >&2 "No such branch $topic" | |||||
exit 1 | |||||
} | |||||
# Is topic fully merged to master? | |||||
not_in_master=`git rev-list --pretty=oneline ^master "$topic"` | |||||
if test -z "$not_in_master" | |||||
then | |||||
echo >&2 "$topic is fully merged to master; better remove it." | |||||
exit 1 ;# we could allow it, but there is no point. | |||||
fi | |||||
# Is topic ever merged to next? If so you should not be rebasing it. | |||||
only_next_1=`git rev-list ^master "^$topic" ${publish} | sort` | |||||
only_next_2=`git rev-list ^master ${publish} | sort` | |||||
if test "$only_next_1" = "$only_next_2" | |||||
then | |||||
not_in_topic=`git rev-list "^$topic" master` | |||||
if test -z "$not_in_topic" | |||||
then | |||||
echo >&2 "$topic is already up-to-date with master" | |||||
exit 1 ;# we could allow it, but there is no point. | |||||
else | |||||
exit 0 | |||||
fi | |||||
else | |||||
not_in_next=`git rev-list --pretty=oneline ^${publish} "$topic"` | |||||
/usr/bin/perl -e ' | |||||
my $topic = $ARGV[0]; | |||||
my $msg = "* $topic has commits already merged to public branch:\n"; | |||||
my (%not_in_next) = map { | |||||
/^([0-9a-f]+) /; | |||||
($1 => 1); | |||||
} split(/\n/, $ARGV[1]); | |||||
for my $elem (map { | |||||
/^([0-9a-f]+) (.*)$/; | |||||
[$1 => $2]; | |||||
} split(/\n/, $ARGV[2])) { | |||||
if (!exists $not_in_next{$elem->[0]}) { | |||||
if ($msg) { | |||||
print STDERR $msg; | |||||
undef $msg; | |||||
} | |||||
print STDERR " $elem->[1]\n"; | |||||
} | |||||
} | |||||
' "$topic" "$not_in_next" "$not_in_master" | |||||
exit 1 | |||||
fi | |||||
<<\DOC_END | |||||
This sample hook safeguards topic branches that have been | |||||
published from being rewound. | |||||
The workflow assumed here is: | |||||
* Once a topic branch forks from "master", "master" is never | |||||
merged into it again (either directly or indirectly). | |||||
* Once a topic branch is fully cooked and merged into "master", | |||||
it is deleted. If you need to build on top of it to correct | |||||
earlier mistakes, a new topic branch is created by forking at | |||||
the tip of the "master". This is not strictly necessary, but | |||||
it makes it easier to keep your history simple. | |||||
* Whenever you need to test or publish your changes to topic | |||||
branches, merge them into "next" branch. | |||||
The script, being an example, hardcodes the publish branch name | |||||
to be "next", but it is trivial to make it configurable via | |||||
$GIT_DIR/config mechanism. | |||||
With this workflow, you would want to know: | |||||
(1) ... if a topic branch has ever been merged to "next". Young | |||||
topic branches can have stupid mistakes you would rather | |||||
clean up before publishing, and things that have not been | |||||
merged into other branches can be easily rebased without | |||||
affecting other people. But once it is published, you would | |||||
not want to rewind it. | |||||
(2) ... if a topic branch has been fully merged to "master". | |||||
Then you can delete it. More importantly, you should not | |||||
build on top of it -- other people may already want to | |||||
change things related to the topic as patches against your | |||||
"master", so if you need further changes, it is better to | |||||
fork the topic (perhaps with the same name) afresh from the | |||||
tip of "master". | |||||
Let's look at this example: | |||||
o---o---o---o---o---o---o---o---o---o "next" | |||||
/ / / / | |||||
/ a---a---b A / / | |||||
/ / / / | |||||
/ / c---c---c---c B / | |||||
/ / / \ / | |||||
/ / / b---b C \ / | |||||
/ / / / \ / | |||||
---o---o---o---o---o---o---o---o---o---o---o "master" | |||||
A, B and C are topic branches. | |||||
* A has one fix since it was merged up to "next". | |||||
* B has finished. It has been fully merged up to "master" and "next", | |||||
and is ready to be deleted. | |||||
* C has not merged to "next" at all. | |||||
We would want to allow C to be rebased, refuse A, and encourage | |||||
B to be deleted. | |||||
To compute (1): | |||||
git rev-list ^master ^topic next | |||||
git rev-list ^master next | |||||
if these match, topic has not merged in next at all. | |||||
To compute (2): | |||||
git rev-list master..topic | |||||
if this is empty, it is fully merged to "master". | |||||
DOC_END |
#!/usr/bin/env bash | |||||
ORI_DIR=`pwd` | |||||
SHELL_FOLDER=$(cd "$(dirname "$0")";pwd) | |||||
cd "$ORI_DIR" | |||||
for i in `ls "$SHELL_FOLDER/pre-receive.d"`; do | |||||
sh "$SHELL_FOLDER/pre-receive.d/$i" | |||||
done |
#!/usr/bin/env bash | |||||
"$GITEA_ROOT/gitea" hook --config="$GITEA_ROOT/$GITEA_CONF" pre-receive |
#!/bin/bash | |||||
echo Hello, World! |
#!/bin/sh | |||||
# | |||||
# An example hook script to prepare the commit log message. | |||||
# Called by "git commit" with the name of the file that has the | |||||
# commit message, followed by the description of the commit | |||||
# message's source. The hook's purpose is to edit the commit | |||||
# message file. If the hook fails with a non-zero status, | |||||
# the commit is aborted. | |||||
# | |||||
# To enable this hook, rename this file to "prepare-commit-msg". | |||||
# This hook includes three examples. The first comments out the | |||||
# "Conflicts:" part of a merge commit. | |||||
# | |||||
# The second includes the output of "git diff --name-status -r" | |||||
# into the message, just before the "git status" output. It is | |||||
# commented because it doesn't cope with --amend or with squashed | |||||
# commits. | |||||
# | |||||
# The third example adds a Signed-off-by line to the message, that can | |||||
# still be edited. This is rarely a good idea. | |||||
case "$2,$3" in | |||||
merge,) | |||||
/usr/bin/perl -i.bak -ne 's/^/# /, s/^# #/#/ if /^Conflicts/ .. /#/; print' "$1" ;; | |||||
# ,|template,) | |||||
# /usr/bin/perl -i.bak -pe ' | |||||
# print "\n" . `git diff --cached --name-status -r` | |||||
# if /^#/ && $first++ == 0' "$1" ;; | |||||
*) ;; | |||||
esac | |||||
# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p') | |||||
# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1" |
#!/usr/bin/env bash | |||||
ORI_DIR=`pwd` | |||||
SHELL_FOLDER=$(cd "$(dirname "$0")";pwd) | |||||
cd "$ORI_DIR" | |||||
for i in `ls "$SHELL_FOLDER/update.d"`; do | |||||
sh "$SHELL_FOLDER/update.d/$i" $1 $2 $3 | |||||
done |
#!/usr/bin/env bash | |||||
"$GITEA_ROOT/gitea" hook --config="$GITEA_ROOT/$GITEA_CONF" update $1 $2 $3 |
#!/bin/sh | |||||
# | |||||
# An example hook script to block unannotated tags from entering. | |||||
# Called by "git receive-pack" with arguments: refname sha1-old sha1-new | |||||
# | |||||
# To enable this hook, rename this file to "update". | |||||
# | |||||
# Config | |||||
# ------ | |||||
# hooks.allowunannotated | |||||
# This boolean sets whether unannotated tags will be allowed into the | |||||
# repository. By default they won't be. | |||||
# hooks.allowdeletetag | |||||
# This boolean sets whether deleting tags will be allowed in the | |||||
# repository. By default they won't be. | |||||
# hooks.allowmodifytag | |||||
# This boolean sets whether a tag may be modified after creation. By default | |||||
# it won't be. | |||||
# hooks.allowdeletebranch | |||||
# This boolean sets whether deleting branches will be allowed in the | |||||
# repository. By default they won't be. | |||||
# hooks.denycreatebranch | |||||
# This boolean sets whether remotely creating branches will be denied | |||||
# in the repository. By default this is allowed. | |||||
# | |||||
# --- Command line | |||||
refname="$1" | |||||
oldrev="$2" | |||||
newrev="$3" | |||||
# --- Safety check | |||||
if [ -z "$GIT_DIR" ]; then | |||||
echo "Don't run this script from the command line." >&2 | |||||
echo " (if you want, you could supply GIT_DIR then run" >&2 | |||||
echo " $0 <ref> <oldrev> <newrev>)" >&2 | |||||
exit 1 | |||||
fi | |||||
if [ -z "$refname" -o -z "$oldrev" -o -z "$newrev" ]; then | |||||
echo "usage: $0 <ref> <oldrev> <newrev>" >&2 | |||||
exit 1 | |||||
fi | |||||
# --- Config | |||||
allowunannotated=$(git config --bool hooks.allowunannotated) | |||||
allowdeletebranch=$(git config --bool hooks.allowdeletebranch) | |||||
denycreatebranch=$(git config --bool hooks.denycreatebranch) | |||||
allowdeletetag=$(git config --bool hooks.allowdeletetag) | |||||
allowmodifytag=$(git config --bool hooks.allowmodifytag) | |||||
# check for no description | |||||
projectdesc=$(sed -e '1q' "$GIT_DIR/description") | |||||
case "$projectdesc" in | |||||
"Unnamed repository"* | "") | |||||
echo "*** Project description file hasn't been set" >&2 | |||||
exit 1 | |||||
;; | |||||
esac | |||||
# --- Check types | |||||
# if $newrev is 0000...0000, it's a commit to delete a ref. | |||||
zero="0000000000000000000000000000000000000000" | |||||
if [ "$newrev" = "$zero" ]; then | |||||
newrev_type=delete | |||||
else | |||||
newrev_type=$(git cat-file -t $newrev) | |||||
fi | |||||
case "$refname","$newrev_type" in | |||||
refs/tags/*,commit) | |||||
# un-annotated tag | |||||
short_refname=${refname##refs/tags/} | |||||
if [ "$allowunannotated" != "true" ]; then | |||||
echo "*** The un-annotated tag, $short_refname, is not allowed in this repository" >&2 | |||||
echo "*** Use 'git tag [ -a | -s ]' for tags you want to propagate." >&2 | |||||
exit 1 | |||||
fi | |||||
;; | |||||
refs/tags/*,delete) | |||||
# delete tag | |||||
if [ "$allowdeletetag" != "true" ]; then | |||||
echo "*** Deleting a tag is not allowed in this repository" >&2 | |||||
exit 1 | |||||
fi | |||||
;; | |||||
refs/tags/*,tag) | |||||
# annotated tag | |||||
if [ "$allowmodifytag" != "true" ] && git rev-parse $refname > /dev/null 2>&1 | |||||
then | |||||
echo "*** Tag '$refname' already exists." >&2 | |||||
echo "*** Modifying a tag is not allowed in this repository." >&2 | |||||
exit 1 | |||||
fi | |||||
;; | |||||
refs/heads/*,commit) | |||||
# branch | |||||
if [ "$oldrev" = "$zero" -a "$denycreatebranch" = "true" ]; then | |||||
echo "*** Creating a branch is not allowed in this repository" >&2 | |||||
exit 1 | |||||
fi | |||||
;; | |||||
refs/heads/*,delete) | |||||
# delete branch | |||||
if [ "$allowdeletebranch" != "true" ]; then | |||||
echo "*** Deleting a branch is not allowed in this repository" >&2 | |||||
exit 1 | |||||
fi | |||||
;; | |||||
refs/remotes/*,commit) | |||||
# tracking branch | |||||
;; | |||||
refs/remotes/*,delete) | |||||
# delete tracking branch | |||||
if [ "$allowdeletebranch" != "true" ]; then | |||||
echo "*** Deleting a tracking branch is not allowed in this repository" >&2 | |||||
exit 1 | |||||
fi | |||||
;; | |||||
*) | |||||
# Anything else (is there anything else?) | |||||
echo "*** Update hook: unknown type of update to ref $refname of type $newrev_type" >&2 | |||||
exit 1 | |||||
;; | |||||
esac | |||||
# --- Finished | |||||
exit 0 |
# git ls-files --others --exclude-from=.git/info/exclude | |||||
# Lines that start with '#' are comments. | |||||
# For a project mostly in C, the following would be a good set of | |||||
# exclude patterns (uncomment them if you want to use them): | |||||
# *.[oa] | |||||
# *~ |
65f1bf27bc3bf70f64657658635e66094edbcb4d refs/heads/master |
65f1bf27bc3bf70f64657658635e66094edbcb4d |
65f1bf27bc3bf70f64657658635e66094edbcb4d |
65f1bf27bc3bf70f64657658635e66094edbcb4d |
65f1bf27bc3bf70f64657658635e66094edbcb4d |
65f1bf27bc3bf70f64657658635e66094edbcb4d |
type: 3 | type: 3 | ||||
config: "{\"IgnoreWhitespaceConflicts\":false,\"AllowMerge\":true,\"AllowRebase\":true,\"AllowRebaseMerge\":true,\"AllowSquash\":true}" | config: "{\"IgnoreWhitespaceConflicts\":false,\"AllowMerge\":true,\"AllowRebase\":true,\"AllowRebaseMerge\":true,\"AllowSquash\":true}" | ||||
created_unix: 1524304355 | created_unix: 1524304355 | ||||
- | |||||
id: 38 | |||||
repo_id: 37 | |||||
type: 4 | |||||
config: "{}" | |||||
created_unix: 946684810 | |||||
- | |||||
id: 39 | |||||
repo_id: 37 | |||||
type: 5 | |||||
config: "{}" | |||||
created_unix: 946684810 | |||||
- | |||||
id: 40 | |||||
repo_id: 37 | |||||
type: 1 | |||||
config: "{}" | |||||
created_unix: 946684810 | |||||
- | |||||
id: 41 | |||||
repo_id: 37 | |||||
type: 2 | |||||
config: "{\"EnableTimetracker\":true,\"AllowOnlyContributorsToTrackTime\":true}" | |||||
created_unix: 946684810 | |||||
- | |||||
id: 42 | |||||
repo_id: 37 | |||||
type: 3 | |||||
config: "{\"IgnoreWhitespaceConflicts\":false,\"AllowMerge\":true,\"AllowRebase\":true,\"AllowRebaseMerge\":true,\"AllowSquash\":true}" | |||||
created_unix: 946684810 |
num_forks: 0 | num_forks: 0 | ||||
num_issues: 0 | num_issues: 0 | ||||
is_mirror: false | is_mirror: false | ||||
- | |||||
id: 37 | |||||
owner_id: 2 | |||||
lower_name: git_hooks_test | |||||
name: git_hooks_test | |||||
is_private: false | |||||
num_stars: 0 | |||||
num_forks: 0 | |||||
num_issues: 0 | |||||
is_mirror: false |
is_admin: false | is_admin: false | ||||
avatar: avatar2 | avatar: avatar2 | ||||
avatar_email: user2@example.com | avatar_email: user2@example.com | ||||
num_repos: 7 | |||||
num_repos: 8 | |||||
num_stars: 2 | num_stars: 2 | ||||
num_followers: 2 | num_followers: 2 | ||||
num_following: 1 | num_following: 1 |
count: 14}, | count: 14}, | ||||
{name: "AllPublic/PublicRepositoriesOfUserIncludingCollaborative", | {name: "AllPublic/PublicRepositoriesOfUserIncludingCollaborative", | ||||
opts: &SearchRepoOptions{Page: 1, PageSize: 10, OwnerID: 15, AllPublic: true}, | opts: &SearchRepoOptions{Page: 1, PageSize: 10, OwnerID: 15, AllPublic: true}, | ||||
count: 20}, | |||||
count: 21}, | |||||
{name: "AllPublic/PublicAndPrivateRepositoriesOfUserIncludingCollaborative", | {name: "AllPublic/PublicAndPrivateRepositoriesOfUserIncludingCollaborative", | ||||
opts: &SearchRepoOptions{Page: 1, PageSize: 10, OwnerID: 15, Private: true, AllPublic: true}, | opts: &SearchRepoOptions{Page: 1, PageSize: 10, OwnerID: 15, Private: true, AllPublic: true}, | ||||
count: 24}, | |||||
count: 25}, | |||||
{name: "AllPublic/PublicAndPrivateRepositoriesOfUserIncludingCollaborativeByName", | {name: "AllPublic/PublicAndPrivateRepositoriesOfUserIncludingCollaborativeByName", | ||||
opts: &SearchRepoOptions{Keyword: "test", Page: 1, PageSize: 10, OwnerID: 15, Private: true, AllPublic: true}, | opts: &SearchRepoOptions{Keyword: "test", Page: 1, PageSize: 10, OwnerID: 15, Private: true, AllPublic: true}, | ||||
count: 14}, | |||||
count: 15}, | |||||
{name: "AllPublic/PublicAndPrivateRepositoriesOfUser2IncludingCollaborativeByName", | {name: "AllPublic/PublicAndPrivateRepositoriesOfUser2IncludingCollaborativeByName", | ||||
opts: &SearchRepoOptions{Keyword: "test", Page: 1, PageSize: 10, OwnerID: 18, Private: true, AllPublic: true}, | opts: &SearchRepoOptions{Keyword: "test", Page: 1, PageSize: 10, OwnerID: 18, Private: true, AllPublic: true}, | ||||
count: 12}, | |||||
count: 13}, | |||||
{name: "AllPublic/PublicRepositoriesOfOrganization", | {name: "AllPublic/PublicRepositoriesOfOrganization", | ||||
opts: &SearchRepoOptions{Page: 1, PageSize: 10, OwnerID: 17, AllPublic: true, Collaborate: util.OptionalBoolFalse}, | opts: &SearchRepoOptions{Page: 1, PageSize: 10, OwnerID: 17, AllPublic: true, Collaborate: util.OptionalBoolFalse}, | ||||
count: 20}, | |||||
count: 21}, | |||||
} | } | ||||
for _, testCase := range testCases { | for _, testCase := range testCases { |
} | } | ||||
// ReferencesGitRepo injects the GitRepo into the Context | // ReferencesGitRepo injects the GitRepo into the Context | ||||
func ReferencesGitRepo() macaron.Handler { | |||||
func ReferencesGitRepo(allowEmpty bool) macaron.Handler { | |||||
return func(ctx *APIContext) { | return func(ctx *APIContext) { | ||||
// Empty repository does not have reference information. | // Empty repository does not have reference information. | ||||
if ctx.Repo.Repository.IsEmpty { | |||||
if !allowEmpty && ctx.Repo.Repository.IsEmpty { | |||||
return | return | ||||
} | } | ||||
} | } | ||||
} | } | ||||
func reqGitHook() macaron.Handler { | |||||
return func(ctx *context.APIContext) { | |||||
if !ctx.User.CanEditGitHook() { | |||||
ctx.Error(403, "", "must be allowed to edit Git hooks") | |||||
return | |||||
} | |||||
} | |||||
} | |||||
func orgAssignment(args ...bool) macaron.Handler { | func orgAssignment(args ...bool) macaron.Handler { | ||||
var ( | var ( | ||||
assignOrg bool | assignOrg bool | ||||
Delete(repo.DeleteHook) | Delete(repo.DeleteHook) | ||||
m.Post("/tests", context.RepoRef(), repo.TestHook) | m.Post("/tests", context.RepoRef(), repo.TestHook) | ||||
}) | }) | ||||
m.Group("/git", func() { | |||||
m.Combo("").Get(repo.ListGitHooks) | |||||
m.Group("/:id", func() { | |||||
m.Combo("").Get(repo.GetGitHook). | |||||
Patch(bind(api.EditGitHookOption{}), repo.EditGitHook). | |||||
Delete(repo.DeleteGitHook) | |||||
}) | |||||
}, reqGitHook(), context.ReferencesGitRepo(true)) | |||||
}, reqToken(), reqAdmin()) | }, reqToken(), reqAdmin()) | ||||
m.Group("/collaborators", func() { | m.Group("/collaborators", func() { | ||||
m.Get("", repo.ListCollaborators) | m.Get("", repo.ListCollaborators) | ||||
}) | }) | ||||
m.Group("/releases", func() { | m.Group("/releases", func() { | ||||
m.Combo("").Get(repo.ListReleases). | m.Combo("").Get(repo.ListReleases). | ||||
Post(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(), bind(api.CreateReleaseOption{}), repo.CreateRelease) | |||||
Post(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(false), bind(api.CreateReleaseOption{}), repo.CreateRelease) | |||||
m.Group("/:id", func() { | m.Group("/:id", func() { | ||||
m.Combo("").Get(repo.GetRelease). | m.Combo("").Get(repo.GetRelease). | ||||
Patch(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(), bind(api.EditReleaseOption{}), repo.EditRelease). | |||||
Patch(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(false), bind(api.EditReleaseOption{}), repo.EditRelease). | |||||
Delete(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.DeleteRelease) | Delete(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.DeleteRelease) | ||||
m.Group("/assets", func() { | m.Group("/assets", func() { | ||||
m.Combo("").Get(repo.ListReleaseAttachments). | m.Combo("").Get(repo.ListReleaseAttachments). | ||||
m.Combo("/merge").Get(repo.IsPullRequestMerged). | m.Combo("/merge").Get(repo.IsPullRequestMerged). | ||||
Post(reqToken(), mustNotBeArchived, reqRepoWriter(models.UnitTypePullRequests), bind(auth.MergePullRequestForm{}), repo.MergePullRequest) | Post(reqToken(), mustNotBeArchived, reqRepoWriter(models.UnitTypePullRequests), bind(auth.MergePullRequestForm{}), repo.MergePullRequest) | ||||
}) | }) | ||||
}, mustAllowPulls, reqRepoReader(models.UnitTypeCode), context.ReferencesGitRepo()) | |||||
}, mustAllowPulls, reqRepoReader(models.UnitTypeCode), context.ReferencesGitRepo(false)) | |||||
m.Group("/statuses", func() { | m.Group("/statuses", func() { | ||||
m.Combo("/:sha").Get(repo.GetCommitStatuses). | m.Combo("/:sha").Get(repo.GetCommitStatuses). | ||||
Post(reqToken(), bind(api.CreateStatusOption{}), repo.NewCommitStatus) | Post(reqToken(), bind(api.CreateStatusOption{}), repo.NewCommitStatus) |
} | } | ||||
} | } | ||||
// ToGitHook convert git.Hook to api.GitHook | |||||
func ToGitHook(h *git.Hook) *api.GitHook { | |||||
return &api.GitHook{ | |||||
Name: h.Name(), | |||||
IsActive: h.IsActive, | |||||
Content: h.Content, | |||||
} | |||||
} | |||||
// ToDeployKey convert models.DeployKey to api.DeployKey | // ToDeployKey convert models.DeployKey to api.DeployKey | ||||
func ToDeployKey(apiLink string, key *models.DeployKey) *api.DeployKey { | func ToDeployKey(apiLink string, key *models.DeployKey) *api.DeployKey { | ||||
return &api.DeployKey{ | return &api.DeployKey{ |
// Copyright 2019 The Gitea Authors. All rights reserved. | |||||
// Use of this source code is governed by a MIT-style | |||||
// license that can be found in the LICENSE file. | |||||
package repo | |||||
import ( | |||||
"code.gitea.io/gitea/modules/context" | |||||
"code.gitea.io/gitea/modules/git" | |||||
"code.gitea.io/gitea/routers/api/v1/convert" | |||||
api "code.gitea.io/sdk/gitea" | |||||
) | |||||
// ListGitHooks list all Git hooks of a repository | |||||
func ListGitHooks(ctx *context.APIContext) { | |||||
// swagger:operation GET /repos/{owner}/{repo}/hooks/git repository repoListGitHooks | |||||
// --- | |||||
// summary: List the Git hooks in a repository | |||||
// produces: | |||||
// - application/json | |||||
// parameters: | |||||
// - name: owner | |||||
// in: path | |||||
// description: owner of the repo | |||||
// type: string | |||||
// required: true | |||||
// - name: repo | |||||
// in: path | |||||
// description: name of the repo | |||||
// type: string | |||||
// required: true | |||||
// responses: | |||||
// "200": | |||||
// "$ref": "#/responses/GitHookList" | |||||
hooks, err := ctx.Repo.GitRepo.Hooks() | |||||
if err != nil { | |||||
ctx.Error(500, "Hooks", err) | |||||
return | |||||
} | |||||
apiHooks := make([]*api.GitHook, len(hooks)) | |||||
for i := range hooks { | |||||
apiHooks[i] = convert.ToGitHook(hooks[i]) | |||||
} | |||||
ctx.JSON(200, &apiHooks) | |||||
} | |||||
// GetGitHook get a repo's Git hook by id | |||||
func GetGitHook(ctx *context.APIContext) { | |||||
// swagger:operation GET /repos/{owner}/{repo}/hooks/git/{id} repository repoGetGitHook | |||||
// --- | |||||
// summary: Get a Git hook | |||||
// produces: | |||||
// - application/json | |||||
// parameters: | |||||
// - name: owner | |||||
// in: path | |||||
// description: owner of the repo | |||||
// type: string | |||||
// required: true | |||||
// - name: repo | |||||
// in: path | |||||
// description: name of the repo | |||||
// type: string | |||||
// required: true | |||||
// - name: id | |||||
// in: path | |||||
// description: id of the hook to get | |||||
// type: string | |||||
// required: true | |||||
// responses: | |||||
// "200": | |||||
// "$ref": "#/responses/GitHook" | |||||
// "404": | |||||
// "$ref": "#/responses/notFound" | |||||
hookID := ctx.Params(":id") | |||||
hook, err := ctx.Repo.GitRepo.GetHook(hookID) | |||||
if err != nil { | |||||
if err == git.ErrNotValidHook { | |||||
ctx.NotFound() | |||||
} else { | |||||
ctx.Error(500, "GetHook", err) | |||||
} | |||||
return | |||||
} | |||||
ctx.JSON(200, convert.ToGitHook(hook)) | |||||
} | |||||
// EditGitHook modify a Git hook of a repository | |||||
func EditGitHook(ctx *context.APIContext, form api.EditGitHookOption) { | |||||
// swagger:operation PATCH /repos/{owner}/{repo}/hooks/git/{id} repository repoEditGitHook | |||||
// --- | |||||
// summary: Edit a Git hook in a repository | |||||
// produces: | |||||
// - application/json | |||||
// parameters: | |||||
// - name: owner | |||||
// in: path | |||||
// description: owner of the repo | |||||
// type: string | |||||
// required: true | |||||
// - name: repo | |||||
// in: path | |||||
// description: name of the repo | |||||
// type: string | |||||
// required: true | |||||
// - name: id | |||||
// in: path | |||||
// description: id of the hook to get | |||||
// type: string | |||||
// required: true | |||||
// - name: body | |||||
// in: body | |||||
// schema: | |||||
// "$ref": "#/definitions/EditGitHookOption" | |||||
// responses: | |||||
// "200": | |||||
// "$ref": "#/responses/GitHook" | |||||
// "404": | |||||
// "$ref": "#/responses/notFound" | |||||
hookID := ctx.Params(":id") | |||||
hook, err := ctx.Repo.GitRepo.GetHook(hookID) | |||||
if err != nil { | |||||
if err == git.ErrNotValidHook { | |||||
ctx.NotFound() | |||||
} else { | |||||
ctx.Error(500, "GetHook", err) | |||||
} | |||||
return | |||||
} | |||||
hook.Content = form.Content | |||||
if err = hook.Update(); err != nil { | |||||
ctx.Error(500, "hook.Update", err) | |||||
return | |||||
} | |||||
ctx.JSON(200, convert.ToGitHook(hook)) | |||||
} | |||||
// DeleteGitHook delete a Git hook of a repository | |||||
func DeleteGitHook(ctx *context.APIContext) { | |||||
// swagger:operation DELETE /repos/{owner}/{repo}/hooks/git/{id} repository repoDeleteGitHook | |||||
// --- | |||||
// summary: Delete a Git hook in a repository | |||||
// produces: | |||||
// - application/json | |||||
// parameters: | |||||
// - name: owner | |||||
// in: path | |||||
// description: owner of the repo | |||||
// type: string | |||||
// required: true | |||||
// - name: repo | |||||
// in: path | |||||
// description: name of the repo | |||||
// type: string | |||||
// required: true | |||||
// - name: id | |||||
// in: path | |||||
// description: id of the hook to get | |||||
// type: string | |||||
// required: true | |||||
// responses: | |||||
// "204": | |||||
// "$ref": "#/responses/empty" | |||||
// "404": | |||||
// "$ref": "#/responses/notFound" | |||||
hookID := ctx.Params(":id") | |||||
hook, err := ctx.Repo.GitRepo.GetHook(hookID) | |||||
if err != nil { | |||||
if err == git.ErrNotValidHook { | |||||
ctx.NotFound() | |||||
} else { | |||||
ctx.Error(500, "GetHook", err) | |||||
} | |||||
return | |||||
} | |||||
hook.Content = "" | |||||
if err = hook.Update(); err != nil { | |||||
ctx.Error(500, "hook.Update", err) | |||||
return | |||||
} | |||||
ctx.Status(204) | |||||
} |
// in:body | // in:body | ||||
EditHookOption api.EditHookOption | EditHookOption api.EditHookOption | ||||
// in:body | |||||
EditGitHookOption api.EditGitHookOption | |||||
// in:body | // in:body | ||||
CreateIssueOption api.CreateIssueOption | CreateIssueOption api.CreateIssueOption | ||||
// in:body | // in:body |
Body []api.Hook `json:"body"` | Body []api.Hook `json:"body"` | ||||
} | } | ||||
// GitHook | |||||
// swagger:response GitHook | |||||
type swaggerResponseGitHook struct { | |||||
// in:body | |||||
Body api.GitHook `json:"body"` | |||||
} | |||||
// GitHookList | |||||
// swagger:response GitHookList | |||||
type swaggerResponseGitHookList struct { | |||||
// in:body | |||||
Body []api.GitHook `json:"body"` | |||||
} | |||||
// Release | // Release | ||||
// swagger:response Release | // swagger:response Release | ||||
type swaggerResponseRelease struct { | type swaggerResponseRelease struct { |
} | } | ||||
} | } | ||||
}, | }, | ||||
"/repos/{owner}/{repo}/hooks/git": { | |||||
"get": { | |||||
"produces": [ | |||||
"application/json" | |||||
], | |||||
"tags": [ | |||||
"repository" | |||||
], | |||||
"summary": "List the Git hooks in a repository", | |||||
"operationId": "repoListGitHooks", | |||||
"parameters": [ | |||||
{ | |||||
"type": "string", | |||||
"description": "owner of the repo", | |||||
"name": "owner", | |||||
"in": "path", | |||||
"required": true | |||||
}, | |||||
{ | |||||
"type": "string", | |||||
"description": "name of the repo", | |||||
"name": "repo", | |||||
"in": "path", | |||||
"required": true | |||||
} | |||||
], | |||||
"responses": { | |||||
"200": { | |||||
"$ref": "#/responses/GitHookList" | |||||
} | |||||
} | |||||
} | |||||
}, | |||||
"/repos/{owner}/{repo}/hooks/git/{id}": { | |||||
"get": { | |||||
"produces": [ | |||||
"application/json" | |||||
], | |||||
"tags": [ | |||||
"repository" | |||||
], | |||||
"summary": "Get a Git hook", | |||||
"operationId": "repoGetGitHook", | |||||
"parameters": [ | |||||
{ | |||||
"type": "string", | |||||
"description": "owner of the repo", | |||||
"name": "owner", | |||||
"in": "path", | |||||
"required": true | |||||
}, | |||||
{ | |||||
"type": "string", | |||||
"description": "name of the repo", | |||||
"name": "repo", | |||||
"in": "path", | |||||
"required": true | |||||
}, | |||||
{ | |||||
"type": "string", | |||||
"description": "id of the hook to get", | |||||
"name": "id", | |||||
"in": "path", | |||||
"required": true | |||||
} | |||||
], | |||||
"responses": { | |||||
"200": { | |||||
"$ref": "#/responses/GitHook" | |||||
}, | |||||
"404": { | |||||
"$ref": "#/responses/notFound" | |||||
} | |||||
} | |||||
}, | |||||
"delete": { | |||||
"produces": [ | |||||
"application/json" | |||||
], | |||||
"tags": [ | |||||
"repository" | |||||
], | |||||
"summary": "Delete a Git hook in a repository", | |||||
"operationId": "repoDeleteGitHook", | |||||
"parameters": [ | |||||
{ | |||||
"type": "string", | |||||
"description": "owner of the repo", | |||||
"name": "owner", | |||||
"in": "path", | |||||
"required": true | |||||
}, | |||||
{ | |||||
"type": "string", | |||||
"description": "name of the repo", | |||||
"name": "repo", | |||||
"in": "path", | |||||
"required": true | |||||
}, | |||||
{ | |||||
"type": "string", | |||||
"description": "id of the hook to get", | |||||
"name": "id", | |||||
"in": "path", | |||||
"required": true | |||||
} | |||||
], | |||||
"responses": { | |||||
"204": { | |||||
"$ref": "#/responses/empty" | |||||
}, | |||||
"404": { | |||||
"$ref": "#/responses/notFound" | |||||
} | |||||
} | |||||
}, | |||||
"patch": { | |||||
"produces": [ | |||||
"application/json" | |||||
], | |||||
"tags": [ | |||||
"repository" | |||||
], | |||||
"summary": "Edit a Git hook in a repository", | |||||
"operationId": "repoEditGitHook", | |||||
"parameters": [ | |||||
{ | |||||
"type": "string", | |||||
"description": "owner of the repo", | |||||
"name": "owner", | |||||
"in": "path", | |||||
"required": true | |||||
}, | |||||
{ | |||||
"type": "string", | |||||
"description": "name of the repo", | |||||
"name": "repo", | |||||
"in": "path", | |||||
"required": true | |||||
}, | |||||
{ | |||||
"type": "string", | |||||
"description": "id of the hook to get", | |||||
"name": "id", | |||||
"in": "path", | |||||
"required": true | |||||
}, | |||||
{ | |||||
"name": "body", | |||||
"in": "body", | |||||
"schema": { | |||||
"$ref": "#/definitions/EditGitHookOption" | |||||
} | |||||
} | |||||
], | |||||
"responses": { | |||||
"200": { | |||||
"$ref": "#/responses/GitHook" | |||||
}, | |||||
"404": { | |||||
"$ref": "#/responses/notFound" | |||||
} | |||||
} | |||||
} | |||||
}, | |||||
"/repos/{owner}/{repo}/hooks/{id}": { | "/repos/{owner}/{repo}/hooks/{id}": { | ||||
"get": { | "get": { | ||||
"produces": [ | "produces": [ | ||||
}, | }, | ||||
"x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" | "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" | ||||
}, | }, | ||||
"EditGitHookOption": { | |||||
"description": "EditGitHookOption options when modifying one Git hook", | |||||
"type": "object", | |||||
"properties": { | |||||
"content": { | |||||
"type": "string", | |||||
"x-go-name": "Content" | |||||
} | |||||
}, | |||||
"x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" | |||||
}, | |||||
"EditHookOption": { | "EditHookOption": { | ||||
"description": "EditHookOption options when modify one hook", | "description": "EditHookOption options when modify one hook", | ||||
"type": "object", | "type": "object", | ||||
}, | }, | ||||
"x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" | "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" | ||||
}, | }, | ||||
"GitHook": { | |||||
"description": "GitHook represents a Git repository hook", | |||||
"type": "object", | |||||
"properties": { | |||||
"content": { | |||||
"type": "string", | |||||
"x-go-name": "Content" | |||||
}, | |||||
"is_active": { | |||||
"type": "boolean", | |||||
"x-go-name": "IsActive" | |||||
}, | |||||
"name": { | |||||
"type": "string", | |||||
"x-go-name": "Name" | |||||
} | |||||
}, | |||||
"x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea" | |||||
}, | |||||
"GitObject": { | "GitObject": { | ||||
"type": "object", | "type": "object", | ||||
"title": "GitObject represents a Git object.", | "title": "GitObject represents a Git object.", | ||||
} | } | ||||
} | } | ||||
}, | }, | ||||
"GitHook": { | |||||
"description": "GitHook", | |||||
"schema": { | |||||
"$ref": "#/definitions/GitHook" | |||||
} | |||||
}, | |||||
"GitHookList": { | |||||
"description": "GitHookList", | |||||
"schema": { | |||||
"type": "array", | |||||
"items": { | |||||
"$ref": "#/definitions/GitHook" | |||||
} | |||||
} | |||||
}, | |||||
"GitTreeResponse": { | "GitTreeResponse": { | ||||
"description": "GitTreeResponse", | "description": "GitTreeResponse", | ||||
"schema": { | "schema": { |
// Copyright 2019 The Gitea Authors. All rights reserved. | |||||
// Use of this source code is governed by a MIT-style | |||||
// license that can be found in the LICENSE file. | |||||
package gitea | |||||
import ( | |||||
"bytes" | |||||
"encoding/json" | |||||
"fmt" | |||||
) | |||||
// GitHook represents a Git repository hook | |||||
type GitHook struct { | |||||
Name string `json:"name"` | |||||
IsActive bool `json:"is_active"` | |||||
Content string `json:"content,omitempty"` | |||||
} | |||||
// GitHookList represents a list of Git hooks | |||||
type GitHookList []*GitHook | |||||
// ListRepoGitHooks list all the Git hooks of one repository | |||||
func (c *Client) ListRepoGitHooks(user, repo string) (GitHookList, error) { | |||||
hooks := make([]*GitHook, 0, 10) | |||||
return hooks, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/hooks/git", user, repo), nil, nil, &hooks) | |||||
} | |||||
// GetRepoGitHook get a Git hook of a repository | |||||
func (c *Client) GetRepoGitHook(user, repo, id string) (*GitHook, error) { | |||||
h := new(GitHook) | |||||
return h, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/hooks/git/%s", user, repo, id), nil, nil, h) | |||||
} | |||||
// EditGitHookOption options when modifying one Git hook | |||||
type EditGitHookOption struct { | |||||
Content string `json:"content"` | |||||
} | |||||
// EditRepoGitHook modify one Git hook of a repository | |||||
func (c *Client) EditRepoGitHook(user, repo, id string, opt EditGitHookOption) error { | |||||
body, err := json.Marshal(&opt) | |||||
if err != nil { | |||||
return err | |||||
} | |||||
_, err = c.getResponse("PATCH", fmt.Sprintf("/repos/%s/%s/hooks/git/%s", user, repo, id), jsonHeader, bytes.NewReader(body)) | |||||
return err | |||||
} | |||||
// DeleteRepoGitHook delete one Git hook from a repository | |||||
func (c *Client) DeleteRepoGitHook(user, repo, id string) error { | |||||
_, err := c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/hooks/git/%s", user, repo, id), nil, nil) | |||||
return err | |||||
} |
} | } | ||||
} | } | ||||
// NewClientWithHTTP creates an API client with a custom http client | |||||
func NewClientWithHTTP(url string, httpClient *http.Client) { | |||||
client := NewClient(url, "") | |||||
client.client = httpClient | |||||
} | |||||
// SetHTTPClient replaces default http.Client with user given one. | // SetHTTPClient replaces default http.Client with user given one. | ||||
func (c *Client) SetHTTPClient(client *http.Client) { | func (c *Client) SetHTTPClient(client *http.Client) { | ||||
c.client = client | c.client = client | ||||
if err != nil { | if err != nil { | ||||
return nil, err | return nil, err | ||||
} | } | ||||
req.Header.Set("Authorization", "token "+c.accessToken) | |||||
if len(c.accessToken) != 0 { | |||||
req.Header.Set("Authorization", "token "+c.accessToken) | |||||
} | |||||
if c.sudo != "" { | if c.sudo != "" { | ||||
req.Header.Set("Sudo", c.sudo) | req.Header.Set("Sudo", c.sudo) | ||||
} | } |
# code.gitea.io/sdk v0.0.0-20190321154058-a669487e86e0 | |||||
# code.gitea.io/sdk v0.0.0-20190416172854-7d954d775498 | |||||
code.gitea.io/sdk/gitea | code.gitea.io/sdk/gitea | ||||
# github.com/BurntSushi/toml v0.3.1 | # github.com/BurntSushi/toml v0.3.1 | ||||
github.com/BurntSushi/toml | github.com/BurntSushi/toml |