Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • gajim/gajim
  • lovetox/gajim
  • ag/gajim
  • linkmauve/gajim
  • asterix/gajim
  • andre/gajim
  • mimi89999/gajim
  • bronko/gajim
  • wurstsalat/gajim
  • baitisj/gajim
  • Dicson/gajim
  • PolynomialDivision/gajim
  • troom/gajim
  • sophie-h/gajim
  • marmistrz/gajim
  • mrDoctorWho/gajim
  • orhideous/gajim
  • jjrh/gajim
  • streaps/gajim
  • jhuffine/gajim
  • maltel/gajim
  • Dominion/gajim
  • norstbox/gajim
  • synchrone/gajim
  • mick3247652/gajim
  • Yuki/gajim
  • l-n-s/gajim
  • ehuelsmann/gajim
  • hrxi/gajim
  • SaltyBones/gajim
  • rlgh/gajim
  • genofire/gajim
  • weblate/gajim
  • PapaTutuWawa/gajim
  • eta/gajim
  • jelmer/gajim
  • Ge0rG/gajim
  • TSRh/gajim
  • tolosaeduard/gajim
  • pitchum/gajim
  • mexicarne/gajim
  • prmcgs/gajim
  • mehw/gajim
  • ecxod/gajim
  • wannestas/gajim
  • XutaxKamay/gajim
  • emil/gajim-fork
  • gs/gajim
  • jurajlutter/gajim
  • Sheldon/gajim-cme
  • dexgs/gajim
  • bodqhrohro/gajim
  • Ermine/gajim
  • mesonium/gajim
  • mjk/gajim
  • nicoco/gajim
  • Polarian/gajim
  • izaya/gajim
  • kurion/gajim
  • npmania/gajim
  • ebertus/gajim
  • intelfx/gajim
  • musipusi/gajim
  • wusspuss/gajim
  • slicht/gajim
  • toms/gajim
  • singpolyma/gajim
  • Antiz/gajim
  • hendursaga/gajim
  • cve-1312/gajim
  • smemes2/gajim
  • amlor/gajim
72 results
Show changes
Commits on Source (2442)
Showing
with 2456 additions and 646 deletions
{{ if .Versions -}}
<a name="unreleased"></a>
## [Unreleased]
{{ if .Unreleased.CommitGroups -}}
{{ range .Unreleased.CommitGroups -}}
{{ .Title }}
{{ range .Commits -}}
* {{if .Refs}}{{range .Refs}}#{{.Ref}} {{end}}{{end}}{{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}
{{ range .Versions }}
<a name="{{ .Tag.Name }}"></a>
## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
Gajim {{ .Tag.Name }} ({{ datetime "02 Jan 2006" .Tag.Date }})
{{ range .CommitGroups -}}
{{ .Title }}
{{ if .Title }} {{ .Title }}{{end}}
{{ range .Commits -}}
* {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
{{ if .Subject }} * {{ .Subject }}{{end}}{{if .Refs}} ({{range .Refs}}#{{.Ref}}{{end}}){{end}}
{{ end }}
{{ end -}}
......@@ -32,13 +17,7 @@ ## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {
{{ end }}
{{ end -}}
{{ end -}}
{{ end -}}
{{- if .Versions }}
[Unreleased]: {{ .Info.RepositoryURL }}/compare/{{ $latest := index .Versions 0 }}{{ $latest.Tag.Name }}...HEAD
{{ range .Versions -}}
{{ if .Tag.Previous -}}
[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
{{ end -}}
{{break}}
{{ end -}}
{{ end -}}
\ No newline at end of file
......@@ -8,19 +8,22 @@ options:
filters:
Type:
- feat
- imprv
- change
- perf
- fix
- imprv
commit_groups:
sort_by: Custom
title_order:
- feat
- imprv
- change
- perf
- fix
title_maps:
feat: New
imprv: Improvements
change: Change
perf: Performance
fix: Bug Fixes
header:
......@@ -34,3 +37,6 @@ options:
refs:
actions:
- Fixes
notes:
keywords:
- NOTES
......@@ -3,20 +3,10 @@ version: 1.1.{build}
image: Visual Studio 2019
environment:
# matrix:
MSYSTEM: MINGW64
MSYS_ARCH: "x86_64"
ARCH: "64bit"
MSYSTEM: MINGW64
ARCH: "64bit"
# - MSYSTEM: MINGW32
# MSYS_ARCH: "i686"
# ARCH: "32bit"
branches:
only:
- master
clone_depth: 1
clone_depth: 10
# init:
# - ps: iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
......@@ -30,10 +20,10 @@ install:
- bash -lc "pacman --needed --noconfirm -Su"
build_script:
- ps: |
$filename = "Gajim-$($env:GAJIM_VERSION)-$($env:ARCH)"
$filename_portable = "Gajim-Portable-$($env:GAJIM_VERSION)-$($env:ARCH)"
$filename_msixbundle = "Gajim-$($env:GAJIM_VERSION)"
if ($env:GAJIM_VERSION -eq "Nightly") {
$time_string=(get-date -UFormat "%Y-%m-%d").ToString()
......@@ -48,10 +38,14 @@ build_script:
C:\msys64\usr\bin\sh.exe --login -c $command
}
bash "git clone C:/projects/gajim C:/msys64/home/appveyor/gajim"
bash "C:/msys64/home/appveyor/gajim/win/build.sh $($env:MSYS_ARCH)"
git clone "$env:APPVEYOR_BUILD_FOLDER" "C:\msys64\home\appveyor\gajim"
bash "C:/msys64/home/appveyor/gajim/win/build.sh"
if ($LastExitCode -ne 0) { $host.SetShouldExit($LastExitCode) }
Push-AppveyorArtifact "$($buildroot)/Gajim.exe" -FileName "$($filename).exe"
Push-AppveyorArtifact "$($buildroot)/Gajim-Portable.exe" -FileName "$($filename_portable).exe"
Push-AppveyorArtifact "$($buildroot)/Gajim.msixbundle" -FileName "$($filename_msixbundle).msixbundle"
if ($LastExitCode -ne 0) { $host.SetShouldExit($LastExitCode) }
# on_finish:
# - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
#!/usr/bin/env python3
import os
import requests
import time
from pathlib import Path
from rich.console import Console
ACCOUNT = 'lovetox'
PROJECT_SLUG = 'gajim'
BRANCH = 'master'
BASE_URL = 'https://ci.appveyor.com/api'
API_KEY = os.environ['APPVEYOR_API_KEY']
HEADERS = {'Authorization': f'Bearer {API_KEY}'}
RETRY_TIMEOUT = 2 * 60
INITIAL_START_DELAY = 20 * 60
SETTINGS_API_URL = f'{BASE_URL}/projects/{ACCOUNT}/{PROJECT_SLUG}/settings/yaml'
BUILDS_API_URL = f'{BASE_URL}/builds'
PROJECT_API_URL = f'{BASE_URL}/projects/{ACCOUNT}/{PROJECT_SLUG}'
console = Console()
def get_gajim_version() -> str:
if os.environ.get('GAJIM_NIGHTLY_BUILD') is not None:
return 'Nightly'
tag = os.environ.get('CI_COMMIT_TAG')
if tag is None:
exit('No tag found')
return tag
def push_yaml_to_project() -> None:
console.print('Push settings ...')
with open('.ci/appveyor.yml', 'r') as file:
yaml = file.read()
req = requests.put(SETTINGS_API_URL, data=yaml, headers=HEADERS)
req.raise_for_status()
def start_build() -> str:
console.print('Start build ...')
payload = {
'accountName': ACCOUNT,
'projectSlug': PROJECT_SLUG,
'branch': BRANCH,
'commitId': os.environ['CI_COMMIT_SHA'],
'environmentVariables': {
'GAJIM_VERSION': get_gajim_version(),
}
}
req = requests.post(BUILDS_API_URL, headers=HEADERS, json=payload)
req.raise_for_status()
response = req.json()
return response['buildId']
def is_build_finished(build: dict[str, str]) -> bool:
if build['status'] in ('failed', 'cancelled'):
exit('Found failed job')
return build['status'] == 'success'
def get_artifacts(build_id: str) -> None:
time.sleep(INITIAL_START_DELAY)
while True:
time.sleep(RETRY_TIMEOUT)
console.print('Check build status ...')
req = requests.get(PROJECT_API_URL, headers=HEADERS)
req.raise_for_status()
response = req.json()
build = response['build']
if build_id != build['buildId']:
exit('Unable to find buildid: %s' % build_id)
if is_build_finished(build):
break
console.print('Build status:', build['status'])
build_folder = Path.cwd() / 'build'
build_folder.mkdir()
for job in build['jobs']:
download_job_artifacts(job['jobId'], build_folder)
console.print('All artifacts downloaded!')
def download_job_artifacts(job_id: str, target_folder: Path) -> None:
artifacts_api_url = f'{BASE_URL}/buildjobs/{job_id}/artifacts'
req = requests.get(artifacts_api_url, headers=HEADERS)
req.raise_for_status()
response = req.json()
for artifact in response:
filename = artifact['fileName']
console.print('Download', filename, '...')
file_url = f'{artifacts_api_url}/{filename}'
req = requests.get(file_url, headers=HEADERS)
req.raise_for_status()
with open(target_folder / filename, 'wb') as file:
file.write(req.content)
if __name__ == '__main__':
push_yaml_to_project()
build_id = start_build()
get_artifacts(build_id)
#!/usr/bin/env python3
from __future__ import annotations
import argparse
import dataclasses
import logging
import shutil
import subprocess
from datetime import datetime
from datetime import timezone
from pathlib import Path
LOG_FORMAT = '%(asctime)s %(levelname)s %(message)s'
logging.basicConfig(format=LOG_FORMAT, level=logging.DEBUG)
log = logging.getLogger()
ROOT_DIR = Path(__file__).resolve().parent.parent
BUILD_DIR = ROOT_DIR / 'debian_build'
DATE = datetime.now().strftime('%Y%m%d')
DATE_TIME = datetime.now(tz=timezone.utc).strftime('%a, %d %b %Y %T %z')
@dataclasses.dataclass
class ReleaseContext:
app: str
pkg_name: str
rev: str
release_name: str
release_dir: Path
tarball: Path
@classmethod
def from_tarball(cls, path: str, prefix: str, rev: str) -> ReleaseContext:
tarball = Path(path)
app = tarball.name.split('-', maxsplit=1)[0]
pkg_name = f'{prefix}{app}-nightly'
release_name = f'{pkg_name}_{DATE}'
release_dir = BUILD_DIR / release_name
return cls(app=app,
pkg_name=pkg_name,
rev=rev,
release_name=release_name,
release_dir=release_dir,
tarball=tarball)
def clean_build_dir() -> None:
log.info('Cleanup build directory')
if BUILD_DIR.exists():
shutil.rmtree(BUILD_DIR)
BUILD_DIR.mkdir()
def prepare_package_dir(context: ReleaseContext) -> None:
log.info('Extract tarball')
tarball = Path(shutil.copy(context.tarball, BUILD_DIR))
tarball = tarball.rename(BUILD_DIR / f'{context.release_name}.orig.tar.gz')
shutil.unpack_archive(tarball, BUILD_DIR)
log.info('Rename dir to: %s', context.release_name)
folder = list(BUILD_DIR.glob(f'{context.app}-?.?.?'))[0]
folder = folder.rename(context.release_dir)
log.info('Copy debian folder into release directory')
shutil.copytree(ROOT_DIR / 'debian', context.release_dir / 'debian')
def prepare_changelog(context: ReleaseContext) -> None:
log.info('Prepare Changelog')
changelog = context.release_dir / 'debian' / 'changelog'
content = changelog.read_text()
content = content.replace('{DATE}', f'{DATE}-{context.rev}')
content = content.replace('{DATE_TIME}', DATE_TIME)
changelog.write_text(content)
def build(context: ReleaseContext) -> None:
log.info('Start package build')
subprocess.run(
[
'dpkg-buildpackage',
'--no-sign'
],
cwd=context.release_dir,
check=True)
if __name__ == '__main__':
parser = argparse.ArgumentParser(description='Build debian package')
parser.add_argument('tarball', help='Path to tarball e.g. app.tar.gz')
parser.add_argument('rev', help='The package revision e.g. 1')
parser.add_argument('--pkgprefix', default='', required=False,
help='Prefix for the package name e.g. python3-')
args = parser.parse_args()
context = ReleaseContext.from_tarball(args.tarball,
args.pkgprefix,
args.rev)
clean_build_dir()
prepare_package_dir(context)
prepare_changelog(context)
build(context)
from typing import Any
from typing import Optional
import functools
import os
import sys
from datetime import date
from ftplib import FTP_TLS
from pathlib import Path
from rich.console import Console
FTP_URL = 'panoramix.gajim.org'
FTP_USER = os.environ['FTP_USER']
FTP_PASS = os.environ['FTP_PASS']
WINDOWS_NIGHTLY_FOLDER = 'downloads/snap/win'
LINUX_NIGHTLY_FOLDER = 'downloads/snap'
RELEASE_FOLDER_BASE = 'downloads'
console = Console()
def ftp_connection(func: Any) -> Any:
@functools.wraps(func)
def func_wrapper(filedir: Path) -> None:
ftp = FTP_TLS(FTP_URL, FTP_USER, FTP_PASS)
console.print('Successfully connected to', FTP_URL)
func(ftp, filedir)
ftp.quit()
console.print('Quit')
return
return func_wrapper
def get_release_folder_from_tag(tag: str) -> str:
numbers = tag.split('.')
return '.'.join(numbers[:2])
def get_gajim_tag() -> str:
tag = os.environ.get('CI_COMMIT_TAG')
if tag is None:
exit('No tag found')
return tag
def find_linux_tarball(filedir: Path) -> Path:
files = list(filedir.glob('gajim-*.tar.gz'))
if len(files) != 1:
exit('Unknown files found')
return files[0]
def get_dir_list(ftp: FTP_TLS) -> list[str]:
return [x[0] for x in ftp.mlsd()]
def create_release_folder(ftp: FTP_TLS, tag: str) -> None:
ftp.cwd(RELEASE_FOLDER_BASE)
folder = get_release_folder_from_tag(tag)
dir_list = get_dir_list(ftp)
if folder not in dir_list:
ftp.mkd(folder)
ftp.cwd(folder)
def upload_all_from_dir(ftp: FTP_TLS, filedir: Path) -> None:
for filepath in filedir.iterdir():
upload_file(ftp, filepath)
def upload_file(ftp: FTP_TLS,
filepath: Path,
name: Optional[str] = None) -> None:
if name is None:
name = filepath.name
console.print('Upload file', filepath.name, 'as', name)
with open(filepath, 'rb') as f:
ftp.storbinary('STOR ' + name, f)
def get_deploy_method() -> str:
deploy_type = os.environ['DEPLOY_TYPE']
is_nightly = bool(os.environ.get('GAJIM_NIGHTLY_BUILD'))
if is_nightly:
return f'deploy_{deploy_type}_nightly'
return f'deploy_{deploy_type}_release'
@ftp_connection
def deploy_windows_nightly(ftp: FTP_TLS, filedir: Path) -> None:
ftp.cwd(WINDOWS_NIGHTLY_FOLDER)
upload_all_from_dir(ftp, filedir)
@ftp_connection
def deploy_windows_release(ftp: FTP_TLS, filedir: Path) -> None:
tag = get_gajim_tag()
create_release_folder(ftp, tag)
upload_all_from_dir(ftp, filedir)
@ftp_connection
def deploy_linux_nightly(ftp: FTP_TLS, filedir: Path) -> None:
ftp.cwd(LINUX_NIGHTLY_FOLDER)
filepath = find_linux_tarball(filedir)
filename = f'gajim-{date.today().isoformat()}.tar.gz'
upload_file(ftp, filepath, name=filename)
@ftp_connection
def deploy_linux_release(ftp: FTP_TLS, file: Path) -> None:
tag = get_gajim_tag()
create_release_folder(ftp, tag)
filepath = find_linux_tarball(filedir)
filename = f'gajim-{tag}.tar.gz'
upload_file(ftp, filepath, name=filename)
if __name__ == '__main__':
filedir = Path(sys.argv[1])
current_module = sys.modules[__name__]
method = getattr(current_module, get_deploy_method())
method(filedir)
#!/usr/bin/env python
# Creates links from gui folder to all files in the gtk folder
# This is needed for pyright to work correctly with the dynamic gui imports
from pathlib import Path
IGNORED_FILES = ['__init__.py']
IGNORED_DIRS = ['__pycache__']
cwd = Path.cwd()
if cwd.name != 'gajim':
exit('Script needs to be excecuted from gajim repository root directory')
gui_path = cwd / 'gajim' / 'gui'
gtk_path = cwd / 'gajim' / 'gtk'
def cleanup_dir(target_dir: Path) -> None:
for path in target_dir.iterdir():
if path.name in IGNORED_FILES:
continue
if path.name in IGNORED_DIRS:
continue
path.unlink()
def link(target: Path) -> None:
source = str(target)
source = source.replace('gajim/gtk', 'gajim/gui')
source = Path(source)
source.symlink_to(target)
print('create symlink from', source, 'to', target)
def link_files(source_dir: Path) -> None:
for path in source_dir.iterdir():
if path.is_dir():
if path.name not in IGNORED_DIRS:
link(path)
elif path.name not in IGNORED_FILES:
link(path)
cleanup_dir(gui_path)
link_files(gtk_path)
#!/bin/sh
echo "$2" | tr -d '\r' | ssh-add - > /dev/null
ssh-add -l
mkdir -p ~/.ssh
chmod 700 ~/.ssh
ssh-keyscan "$1" >> ~/.ssh/known_hosts
git config --global user.email "$CI_GIT_USER_EMAIL"
git config --global user.name "$CI_GIT_USER_USERNAME"
#!/bin/sh
# exit when any command fails
set -e
PYLINT=${PYLINT:-pylint}
# Errors which are covered by pyright
#
# E1101 no-member
# E1102 not-callable
# E1111 assignment-from-no-return
# E1120 no-value-for-parameter
# E1121 too-many-function-args
# E1123 unexpected-keyword-arg
# E1124 redundant-keyword-arg
# E1125 missing-kwoa
# E1126 invalid-sequence-index
# E1127 invalid-slice-index
# E1128 assignment-from-none
# E1129 not-context-manager
# E1130 invalid-unary-operand-type
# E1131 unsupported-binary-operation
# E1132 repeated-keyword
# E1133 not-an-iterable
# E1134 not-a-mapping
# E1135 unsupported-membership-test
# E1136 unsubscriptable-object
# E1137 unsupported-assignment-operation
# E1138 unsupported-delete-operation
# E1139 invalid-metaclass
# E1140 unhashable-dict-key
# E1141 dict-iter-missing-items
# E1142 await-outside-async
# I1101 c-extension-no-member
# W0212 protected-access
# W1113 keyword-arg-before-vararg
# W1114 arguments-out-of-order
# W1115 non-str-assignment-to-dunder-name
# W1116 isinstance-second-argument-not-valid-type
IGNORE_PYRIGHT='E1101,E1102,E1111,E1120,E1121,E1123,E1124,E1125,E1126,E1127,E1128,E1129,E1130,E1131,E1132,E1133,E1134,E1135,E1136,E1137,E1138,E1139,E1140,E1141,E1142,I1101,W0212,W1113,W1114,W1115,W1116'
IGNORE_ALWAYS='R0801,C0209,W0237,W0707,R1732,W1404,W1406,R1725'
IGNORE_ERRORS=C0103,C0302,C0301,C0330,C0411,C0415,E0401,E0611,R0201,R0901,R0904,R0912,R0913,R0914,R0915,R0916,R1702,R1710,W0201,W0221,W0223,W0231,W0233,W0603,W0613
IGNORE_GTK_MODULE_ERRORS=C0103,C0301,C0330,C0415,E0401,E0611,R0201,R0904,R0915,R1710,W0201,W0233,W0221,W0613
"$PYLINT" --version
"$PYLINT" --disable="$IGNORE_PYRIGHT,$IGNORE_ALWAYS,$IGNORE_ERRORS" --ignore=modules,dbus,gtk "$@"
"$PYLINT" --disable="$IGNORE_PYRIGHT,$IGNORE_ALWAYS,$IGNORE_GTK_MODULE_ERRORS" "$@/gtk"
"$PYLINT" --disable="$IGNORE_PYRIGHT,$IGNORE_ALWAYS,E0401,C0415" "$@/common/modules"
"$PYLINT" --disable="$IGNORE_PYRIGHT,$IGNORE_ALWAYS" "$@/common/dbus"
# C0103 invalid-name
# C0209 use-f-string
# C0301 line-too-long
# C0302 too-many-lines
# C0330 bad-continuation
# C0415 import-outside-toplevel
# E0401 import-error
# E0611 no-name-in-module
# R0201 no-self-use
# R0801 duplicat-code
# R0901 too-many-ancestors
# R0904 too-many-public-methods
# R0913 too-many-arguments
# R0912 too-many-branches
# R0914 too-many-locals
# R0915 too-many-statements
# R0916 too-many-boolean-expressions
# R1702 too-many-nested-blocks
# R1710 inconsistent-return-statements
# R1732 consider-using-with
# R1725 super-with-arguments
# W0201 attribute-defined-outside-init
# W0221 arguments-differ
# W0223 abstract-method
# W0231 super-init-not-called
# W0233 non-parent-init-called
# W0237 arguments-renamed
# W0603 global-statement
# W0613 unused-argument
# W0707 raise-missing-from
# W1404 implicit-str-concat
# W1406 redundant-u-string-prefix
......@@ -5,20 +5,24 @@ from __future__ import annotations
from typing import List
from typing import Tuple
import sys
import subprocess
import sys
ALLOWED_TAGS = [
'ci',
'feat',
'fix',
'perf',
'refactor',
'chore',
'release',
'other',
'imprv',
"ci",
"cfix",
"new",
"cq",
"feat",
"fix",
"perf",
"refactor",
"chore",
"change",
"release",
"other",
"imprv",
"revert",
]
......@@ -30,48 +34,54 @@ def parse_args() -> Tuple[str, str, str]:
def get_commit_subject(sha: str) -> str:
data = subprocess.check_output(
['git', 'log', '-1', '--pretty=format:%s', sha])
data = subprocess.check_output(["git", "log", "-1", "--pretty=format:%s", sha])
return data.decode()
def get_commit_shas(start_ref: str, end_ref: str) -> List[str]:
arg = f'{start_ref}..{end_ref}'
data = subprocess.check_output(['git', 'rev-list', arg])
arg = f"{start_ref}..{end_ref}"
data = subprocess.check_output(["git", "rev-list", arg])
text = data.decode()
text = text.strip()
return text.split('\n')
if not text:
# Can happen if commits are deleted after force push
return []
return text.split("\n")
def enforce_message_rules(subject: str) -> None:
try:
tag, subject = subject.split(': ', maxsplit=1)
tag, subject = subject.split(": ", maxsplit=1)
except ValueError:
print('Unknown commit message tag:', subject)
print("Unknown commit message tag:", subject)
sys.exit(1)
if tag not in ALLOWED_TAGS:
print('Unknown commit message tag:', tag)
print("Unknown commit message tag:", tag)
sys.exit(1)
if tag == 'release':
if tag == "release":
if not subject[0].isdigit():
print('Release commits should be of the form "release: X.X.X"')
sys.exit(1)
return
if not subject[0].isupper():
print('First letter after tag must be uppercase')
print("First letter after tag must be uppercase")
sys.exit(1)
def main(args: Tuple[str, str, str]) -> None:
ref_name, old_ref, new_ref = args
if 'refs/tags' in ref_name:
print("UPDATE", ref_name, old_ref, new_ref)
if ref_name != "refs/heads/master":
# We enforce only for master branch
return
shas = get_commit_shas(old_ref, new_ref)
for sha in shas:
print("Check", sha)
subject = get_commit_subject(sha)
enforce_message_rules(subject)
......
......@@ -2,20 +2,19 @@ syntax: glob
*.orig
*.swp
*.gmo
*.in
*.m4
*.pyc
*.pyo
*~
*#
gajim/gui/*
!gajim/gui/__init__.py
gajim/data/locale
# Cache
__pycache__/
.mypy_cache/
.ruff_cache/
# Build folders
......@@ -24,7 +23,14 @@ build/
dist/
gajim.egg-info/
win/_build_root
venv/
.venv/
node_modules/
.flatpak-builder
# IDE files
.vscode
*.sublime-project
*.sublime-workspace
.idea
image: gajim-master:latest
workflow:
rules:
- if: $GAJIM_NIGHTLY_BUILD
- if: $NIGHTLY_BUILD
- if: $DEBIAN_BUILD
- if: $WINDOWS_BUILD
- if: $DEPLOY_FLATPAK
- if: $CI_PIPELINE_SOURCE == "push"
stages:
......@@ -12,144 +13,339 @@ stages:
- publish
test-other:
image: gajim-test
stage: test
script:
- ./make.py build
- pyproject-build
- appstream-util validate dist/metadata/org.gajim.Gajim.metainfo.xml
interruptible: true
test-black:
image: gajim-test
stage: test
rules:
- changes:
- "**/*.py"
script:
- codespell -I codespell.conf --skip="*__pycache__*,gajim/data/icons,gajim/data/sounds,gajim/data/emoticons" gajim
- python3 setup.py build
- appstream-util validate build/data/org.gajim.Gajim.appdata.xml
- black --version
- black --check .
interruptible: true
test-codespell:
image: gajim-test
stage: test
script:
- codespell --version
- codespell gajim
interruptible: true
test-pyright:
image: gajim-test
stage: test
rules:
- changes:
- "**/*.py"
script:
- pip3 install git+https://dev.gajim.org/gajim/python-nbxmpp.git
- pip3 install git+https://github.com/pygobject/pygobject-stubs.git
- npm install pyright
- python3 .ci/link-gtk.py
- $(npm bin)/pyright --version
- $(npm bin)/pyright
- pip install git+https://dev.gajim.org/gajim/python-nbxmpp.git
- pip install git+https://dev.gajim.org/gajim/omemo-dr.git
- pip install --config-settings=config=Gtk4,Gdk4,GtkSource5 git+https://github.com/pygobject/pygobject-stubs.git
- pyright --version
- pyright
interruptible: true
test-pylint:
test-ruff:
image: gajim-test
stage: test
rules:
- changes:
- "**/*.py"
script:
- pip3 install -I git+https://dev.gajim.org/gajim/python-nbxmpp.git
- .ci/pylint.sh --jobs=2 gajim
- ruff --version
- ruff check .
interruptible: true
test-isort:
image: gajim-test
stage: test
rules:
- changes:
- "**/*.py"
script:
- isort --version
- isort --check .
interruptible: true
test-unittest:
image: gajim-test
stage: test
script:
- pip3 install -I git+https://dev.gajim.org/gajim/python-nbxmpp.git
- pip install git+https://dev.gajim.org/gajim/python-nbxmpp.git
- coverage run --source=gajim -m unittest discover -s test -v
- coverage report -mi
- coverage xml -i
coverage: "/TOTAL.+ ([0-9]{1,3}%)/"
artifacts:
reports:
cobertura: coverage.xml
coverage_report:
coverage_format: cobertura
path: coverage.xml
interruptible: true
build-linux:
image: gajim-deb-build:latest
build-unix:
image: gajim-build
stage: build
dependencies: []
rules:
- if: '$GAJIM_NIGHTLY_BUILD'
- if: '$DEBIAN_BUILD'
- if: '$NIGHTLY_BUILD'
- if: '$CI_COMMIT_TAG'
script:
- python3 setup.py sdist
- python3 .ci/debian_build.py "$(find dist/gajim-*)" 1
- ./make.py build
- pyproject-build
artifacts:
name: "gajim-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHA"
expire_in: 1 week
paths:
- dist/gajim-*.tar.gz
- dist/gajim-*.whl
build-and-deploy-windows:
build-debian-nightly:
image: gajim-build
stage: build
rules:
- if: '$GAJIM_NIGHTLY_BUILD'
- if: '$CI_COMMIT_TAG'
variables:
DEPLOY_TYPE: "windows"
REV: "1"
needs:
- job: build-unix
artifacts: true
rules:
- if: '$DEBIAN_BUILD'
- if: '$NIGHTLY_BUILD'
allow_failure: true
script:
- python3 .ci/appveyor_build.py
- python3 .ci/deploy.py build
- apt-get update
- apt-get install -y python3-nbxmpp-nightly
- apt-get install -y python3-omemo-dr
- release-helper build-debian-pkg "$(find dist/gajim-*.tar.gz)" $REV --pkgsuffix=nightly
# artifacts:
# expire_in: 1 day
# paths:
# - build/Gajim-*.exe
artifacts:
name: "gajim-$CI_COMMIT_REF_NAME-$CI_COMMIT_SHA"
expire_in: 1 week
paths:
- debian_build/*
deploy-linux:
# build-windows:
# image: gajim-build
# stage: build
# dependencies: []
# rules:
# - if: '$CI_COMMIT_TAG'
# script:
# - >
# release-helper build-windows-pkg \
# --account=lovetox \
# --repository=https://dev.gajim.org/gajim/gajim \
# --branch=master \
# --version=$CI_COMMIT_TAG \
# --commit-sha=$CI_COMMIT_SHA \
# --api-key=$APPVEYOR_API_KEY \
# .ci/appveyor.yml
# artifacts:
# expire_in: 1 day
# paths:
# - windows_build/*.json
build-windows-nightly:
image: gajim-build
stage: build
dependencies: []
rules:
- if: '$NIGHTLY_BUILD'
- if: '$WINDOWS_BUILD'
script:
- >
release-helper build-windows-pkg \
--account=lovetox \
--repository=https://dev.gajim.org/gajim/gajim \
--branch=master \
--version=Nightly \
--commit-sha=$CI_COMMIT_SHA \
--api-key=$APPVEYOR_API_KEY \
.ci/appveyor.yml
artifacts:
expire_in: 1 day
paths:
- windows_build/*.json
deploy-unix:
image: gajim-deploy
stage: deploy
needs: ['build-linux']
dependencies:
- build-unix
rules:
- if: '$GAJIM_NIGHTLY_BUILD'
- if: '$CI_COMMIT_TAG'
variables:
DEPLOY_TYPE: "linux"
script:
- python3 .ci/deploy.py dist
- >
release-helper deploy-to-ftp \
--host=$FTP_HOST \
--user=$FTP_USER \
--password=$FTP_PASS \
--directory=downloads/"$(echo $CI_COMMIT_TAG | cut -c 1-3)" \
--rename=gajim-$CI_COMMIT_TAG.tar.gz \
"$(find dist/gajim-*.tar.gz)"
deploy-unix-nightly:
image: gajim-deploy
stage: deploy
dependencies:
- build-unix
needs:
- build-unix
rules:
- if: '$NIGHTLY_BUILD'
allow_failure:
exit_codes:
- 100
script:
- release-helper nightly-check
- >
release-helper deploy-to-ftp \
--host=$FTP_HOST \
--user=$FTP_USER \
--password=$FTP_PASS \
--directory=downloads/snap \
--rename=gajim-"$(date +'%Y-%m-%d')".tar.gz \
"$(find dist/gajim-*.tar.gz)"
deploy-debian-nightly:
image: gajim-deploy
stage: deploy
dependencies:
- build-debian-nightly
needs:
- build-debian-nightly
rules:
- if: '$DEBIAN_BUILD'
- if: '$NIGHTLY_BUILD'
allow_failure: true
script:
- |
if [ "$FORCE_DEB_DEPLOY" != "true" ]
then
release-helper nightly-check
fi
- >
release-helper deploy-to-ftp \
--host=$FTP_HOST \
--user=$FTP_USER \
--password=$FTP_PASS \
--directory=debian/gajim/"$(date +'%Y%m%d')" \
debian_build
# deploy-windows:
# image: gajim-deploy
# stage: deploy
# needs: ['build-windows']
# dependencies:
# - build-windows
# rules:
# - if: '$GAJIM_NIGHTLY_BUILD'
# - if: '$CI_COMMIT_TAG'
# when: manual
# variables:
# DEPLOY_TYPE: "windows"
# script:
# - python3 .ci/deploy.py build
# - release-helper download-appveyor-artifacts "$(find windows_build/*.json)" windows_build
# - rm windows_build/*.json
# - >
# release-helper deploy-to-ftp \
# --host=$FTP_HOST \
# --user=$FTP_USER \
# --password=$FTP_PASS \
# --directory=downloads/"$(echo $CI_COMMIT_TAG | cut -c 1-3)" \
# windows_build
deploy-windows-nightly:
image: gajim-deploy
stage: deploy
dependencies:
- build-windows-nightly
needs:
- build-windows-nightly
rules:
- if: '$NIGHTLY_BUILD'
- if: '$WINDOWS_BUILD'
allow_failure:
exit_codes:
- 100
script:
- release-helper nightly-check
- release-helper download-appveyor-artifacts "$(find windows_build/*.json)" windows_build
- rm windows_build/*.json
- >
release-helper deploy-to-ftp \
--host=$FTP_HOST \
--user=$FTP_USER \
--password=$FTP_PASS \
--directory=downloads/snap/win \
windows_build
deploy-flatpak:
image: git-deploy:latest
image: gajim-deploy
stage: deploy
needs: []
dependencies: []
rules:
- if: '$DEPLOY_FLATPAK'
- if: '$CI_COMMIT_TAG'
before_script:
# - echo "${FLATHUB_DEPLOY_KEY}" | tr -d '\r' | ssh-add - > /dev/null
- mkdir -p ~/.ssh
- ssh-keyscan https://github.com >> ~/.ssh/known_hosts
- eval $(ssh-agent -s)
- .ci/prepare_git.sh github.com "${FLATHUB_DEPLOY_KEY}"
script:
- git config user.email "$CI_GIT_USER_EMAIL"
- git config user.name "$CI_GIT_USER_USERNAME"
- git clone https://github.com/flathub/org.gajim.Gajim.git
# extract the current commit hash of the shared-modules submodule
- submodule_commit=$(git submodule status flatpak/shared-modules | cut -c 2-41)
- git clone git@github.com:flathub/org.gajim.Gajim.git
- cd org.gajim.Gajim
- mv ../flatpak/org.gajim.Gajim.yaml org.gajim.Gajim.yaml
- mv ../flatpak/app-overrides.json app-overrides.json
# point the shared-modules submodule to the new commit, without fetching the repository
- git update-index --cacheinfo 160000,${submodule_commit},shared-modules
- git diff
- git add org.gajim.Gajim.yaml
- git commit -m "$CI_COMMIT_TAG"
# - git push
- git add --all
- git commit -m "$CI_COMMIT_TAG$DEPLOY_FLATPAK"
- git push
publish-release:
image: git-deploy:latest
publish-website:
image: gajim-publish
stage: publish
needs: ['deploy-linux', build-and-deploy-windows]
dependencies: []
rules:
- if: '$CI_COMMIT_TAG'
before_script:
- echo "${WEBSITE_DEPLOY_KEY}" | tr -d '\r' | ssh-add - > /dev/null
- mkdir -p ~/.ssh
- ssh-keyscan dev.gajim.org >> ~/.ssh/known_hosts
- eval $(ssh-agent -s)
- .ci/prepare_git.sh dev.gajim.org "${WEBSITE_DEPLOY_KEY}"
script:
- git config --global user.email "$CI_GIT_USER_EMAIL"
- git config --global user.name "$CI_GIT_USER_USERNAME"
- git clone git@dev.gajim.org:gajim/website.git
- cd website
- git checkout master
- python3 ./scripts/bump_version.py $CI_COMMIT_TAG
- python ./scripts/bump_version.py $CI_COMMIT_TAG
- git diff
- git add -u
- git commit -m "Release Gajim $CI_COMMIT_TAG"
- git push
publish-release:
image: gajim-publish
stage: publish
dependencies: []
rules:
- if: '$CI_COMMIT_TAG'
script:
- >
release-helper finish-milestone \
$CI_PROJECT_ID \
$PROJECT_TOKEN \
--version=$CI_COMMIT_TAG \
--title="Next Release"
- >
release-helper create-release \
$CI_PROJECT_ID \
$PROJECT_TOKEN \
--version=$CI_COMMIT_TAG \
--tag=$CI_COMMIT_TAG \
--milestone=$CI_COMMIT_TAG
*Release date: xx xxx xxxx*
## Things to do before release:
## Preparations
* [ ] xxx
* [ ] Raise nbxmpp version (if necessary)
## Build
* [ ] Merge translations from Weblate
* [ ] Update `ChangeLog`
* [ ] Update IANA data with `./scripts/get_iana_data.py gajim/common/iana.py`
* [ ] Run `./scripts/update_flatpak_manifest.py`
* [ ] Run `./scripts/bump_version.py x.x.x`
* [ ] Push release tag `x.x.x`
* [ ] Upload .msixbundle to Windows store
* [ ] Close release milestone after new milestone has been created automatically
## Update
* [ ] Website: Write announcement post with changelog
* [ ] Website: Update Download section on gajim.org (set [current version and update installer links](https://dev.gajim.org/gajim/website/blob/master/themes/beautifulhugo/data/Gajim.json))
* [ ] Website: Update screenshots
* [ ] Website: Merge website translations from Weblate
* [ ] MUC: Update MUC subject on gajim@conference.gajim.org
* [ ] Publish release post on [Fosstodon](https://fosstodon.org/@gajim)
repos:
- repo: https://github.com/charliermarsh/ruff-pre-commit
rev: v0.9.7
hooks:
- id: ruff
exclude: ".githooks/"
- repo: https://github.com/codespell-project/codespell
rev: v2.4.1
hooks:
- id: codespell
pass_filenames: false
additional_dependencies:
- tomli
- repo: https://github.com/RobertCraigie/pyright-python
rev: v1.1.394
hooks:
- id: pyright
pass_filenames: false
additional_dependencies:
- nbxmpp @ git+https://dev.gajim.org/gajim/python-nbxmpp.git
- PyGObject-stubs @ git+https://github.com/pygobject/pygobject-stubs.git
- python-gitlab
- ruamel.yaml
- sentry-sdk
stages: [manual]
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/psf/black
# The `refs/tags/<tag>:refs/tags/<tag>` is needed for black's required-version to work:
# https://github.com/psf/black/issues/2493#issuecomment-1081987650
rev: 'refs/tags/24.10.0:refs/tags/24.10.0'
hooks:
- id: black
- repo: https://github.com/fsfe/reuse-tool
rev: v5.0.2
hooks:
- id: reuse
stages: [manual]
......@@ -34,14 +34,24 @@ # Commit Messages
Every commit message must be prefixed with one of the following tags:
- ci (ci related changes)
- feat (functionality of the application was changed)
Changelog relevant
- feat (a new feature was added)
- fix (something was fixed)
- perf (performance related changes)
- imprv (improvements)
- change (existing functionality was changed)
Prefixes for development
- new (new code, but the end user will not notice)
- ci (ci related changes)
- cq (code quality changes e.g. formatting, typing, codestyle)
- cfix (code fixes which should not show up in the changelog)
- refactor (code was changed, but the end user will not notice)
- chore (reoccuring tasks which need to be done)
- release (only used for release commits)
- revert (used when a commit needs to be reverted)
- other
Further the first letter after the tag must be upper case
......@@ -49,3 +59,28 @@ # Commit Messages
Example:
`feat: New Button which does something`
# Use pre-commit
Execute the following inside the repository dir
$ pip install pre-commit
$ pre-commit install
Now pre-commit will run various checks before code can be committed.
To update to the newest versions
$ pre-commit autoupdate
# Man Pages
Man pages are written in markdown and converted with pandoc
While developing this command is useful to preview the manpage
$ pandoc gajim.1.md -s -t man | /usr/bin/man -l -
To convert the markdown
$ pandoc gajim.1.md -s -t man -o gajim.1
This diff is collapsed.
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
one line to give the program's name and an idea of what it does. Copyright (C) yyyy name of author
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.
signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
one line to give the program's name and an idea of what it does. Copyright (C) yyyy name of author
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker.
signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice
This diff is collapsed.
This diff is collapsed.