MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Start process to get rid of master branch

This commit is contained in:
Georg Krause 2021-09-21 13:36:16 +02:00
parent e5b95c82a4
commit e96d2dab10
No known key found for this signature in database
GPG Key ID: FD479B9A4D48E632
7 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.gitlab-ci.yml
View File

@ -218,6 +218,7 @@ build_front:
only: only:
- tags@funkwhale/funkwhale - tags@funkwhale/funkwhale
- master@funkwhale/funkwhale - master@funkwhale/funkwhale
- stable@funkwhale/funkwhale
- develop@funkwhale/funkwhale - develop@funkwhale/funkwhale
tags: tags:
- docker - docker
@ -242,7 +243,7 @@ pages:
paths: paths:
- public - public
only: only:
- master@funkwhale/funkwhale - stable@funkwhale/funkwhale
tags: tags:
- docker - docker
@ -254,7 +255,7 @@ docker_release:
before_script: before_script:
- docker login -u $DOCKER_LOGIN -p $DOCKER_PASSWORD - docker login -u $DOCKER_LOGIN -p $DOCKER_PASSWORD
- cp -r front/dist api/frontend - cp -r front/dist api/frontend
- (if [ "$CI_COMMIT_REF_NAME" == "develop" ] || [ "$CI_COMMIT_REF_NAME" == "master" ]; then ./scripts/set-api-build-metadata.sh $(echo $CI_COMMIT_SHA | cut -c 1-8); fi); - (if [ "$CI_COMMIT_REF_NAME" == "develop" ] || [ "$CI_COMMIT_REF_NAME" == "stable" ]; then ./scripts/set-api-build-metadata.sh $(echo $CI_COMMIT_SHA | cut -c 1-8); fi);
script: script:
- if [[ ! -z "$CI_COMMIT_TAG" ]]; then (./docs/get-releases-json.py | scripts/is-docker-latest.py $CI_COMMIT_TAG -) && export DOCKER_LATEST_TAG="-t $IMAGE_LATEST" || export DOCKER_LATEST_TAG=; fi - if [[ ! -z "$CI_COMMIT_TAG" ]]; then (./docs/get-releases-json.py | scripts/is-docker-latest.py $CI_COMMIT_TAG -) && export DOCKER_LATEST_TAG="-t $IMAGE_LATEST" || export DOCKER_LATEST_TAG=; fi
- if [[ "$CI_COMMIT_REF_NAME" =~ ^[0-9]+(.[0-9]+){1,2}$ ]]; then export stable=1 && export major="$(echo $CI_COMMIT_REF_NAME | cut -d '.' -f 1)" && export minor="$(echo $CI_COMMIT_REF_NAME | cut -d '.' -f 1,2)"; fi - if [[ "$CI_COMMIT_REF_NAME" =~ ^[0-9]+(.[0-9]+){1,2}$ ]]; then export stable=1 && export major="$(echo $CI_COMMIT_REF_NAME | cut -d '.' -f 1)" && export minor="$(echo $CI_COMMIT_REF_NAME | cut -d '.' -f 1,2)"; fi
@ -266,7 +267,7 @@ docker_release:
- if [[ $stable == 1 ]]; then docker tag $IMAGE $IMAGE_NAME:$minor && docker push $IMAGE_NAME:$minor; fi - if [[ $stable == 1 ]]; then docker tag $IMAGE $IMAGE_NAME:$minor && docker push $IMAGE_NAME:$minor; fi
only: only:
- develop@funkwhale/funkwhale - develop@funkwhale/funkwhale
- master@funkwhale/funkwhale - stable@funkwhale/funkwhale
- tags@funkwhale/funkwhale - tags@funkwhale/funkwhale
docker_all_in_one_release: docker_all_in_one_release:
@ -280,7 +281,7 @@ docker_all_in_one_release:
BUILD_PATH: all_in_one BUILD_PATH: all_in_one
before_script: before_script:
- docker login -u $DOCKER_LOGIN -p $DOCKER_PASSWORD - docker login -u $DOCKER_LOGIN -p $DOCKER_PASSWORD
- (if [ "$CI_COMMIT_REF_NAME" == "develop" ] || [ "$CI_COMMIT_REF_NAME" == "master" ]; then ./scripts/set-api-build-metadata.sh $(echo $CI_COMMIT_SHA | cut -c 1-8); fi); - (if [ "$CI_COMMIT_REF_NAME" == "develop" ] || [ "$CI_COMMIT_REF_NAME" == "master" ] || [ "$CI_COMMIT_REF_NAME" == "stable" ]; then ./scripts/set-api-build-metadata.sh $(echo $CI_COMMIT_SHA | cut -c 1-8); fi);
script: script:
- if [[ ! -z "$CI_COMMIT_TAG" ]]; then (./docs/get-releases-json.py | scripts/is-docker-latest.py $CI_COMMIT_TAG -) && export DOCKER_LATEST_TAG="-t $ALL_IN_ONE_IMAGE_LATEST" || export DOCKER_LATEST_TAG=; fi - if [[ ! -z "$CI_COMMIT_TAG" ]]; then (./docs/get-releases-json.py | scripts/is-docker-latest.py $CI_COMMIT_TAG -) && export DOCKER_LATEST_TAG="-t $ALL_IN_ONE_IMAGE_LATEST" || export DOCKER_LATEST_TAG=; fi
- wget $ALL_IN_ONE_ARTIFACT_URL -O all_in_one.zip - wget $ALL_IN_ONE_ARTIFACT_URL -O all_in_one.zip
@ -296,6 +297,7 @@ docker_all_in_one_release:
only: only:
- develop@funkwhale/funkwhale - develop@funkwhale/funkwhale
- master@funkwhale/funkwhale - master@funkwhale/funkwhale
- stable@funkwhale/funkwhale
- tags@funkwhale/funkwhale - tags@funkwhale/funkwhale
build_api: build_api:
@ -308,12 +310,13 @@ build_api:
- api - api
script: script:
- rm -rf api/tests - rm -rf api/tests
- (if [ "$CI_COMMIT_REF_NAME" == "develop" ] || [ "$CI_COMMIT_REF_NAME" == "master" ]; then ./scripts/set-api-build-metadata.sh $(echo $CI_COMMIT_SHA | cut -c 1-8); fi); - (if [ "$CI_COMMIT_REF_NAME" == "develop" ] || [ "$CI_COMMIT_REF_NAME" == "stable" ] || [ "$CI_COMMIT_REF_NAME" == "master" ]; then ./scripts/set-api-build-metadata.sh $(echo $CI_COMMIT_SHA | cut -c 1-8); fi);
- chmod -R 750 api - chmod -R 750 api
- echo Done! - echo Done!
only: only:
- tags@funkwhale/funkwhale - tags@funkwhale/funkwhale
- master@funkwhale/funkwhale - master@funkwhale/funkwhale
- stable@funkwhale/funkwhale
- develop@funkwhale/funkwhale - develop@funkwhale/funkwhale
check_api_dependencies: check_api_dependencies:

10
CONTRIBUTING.rst
View File

@ -100,7 +100,7 @@ Visit https://dev.funkwhale.audio/funkwhale/funkwhale and clone the repository u
A note about branches A note about branches
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
Next release development occurs on the "develop" branch, and releases are made on the "master" branch. Therefore, when submitting Merge Requests, ensure you are merging on the develop branch. Next release development occurs on the "develop" branch, and releases are made on the "stable" branch. Therefore, when submitting Merge Requests, ensure you are merging on the develop branch.
Working with docker Working with docker
@ -750,7 +750,7 @@ To make a new 3.4 release::
export PREVIOUS_RELEASE=3.3 # replace with the previous release number export PREVIOUS_RELEASE=3.3 # replace with the previous release number
# ensure you have an up-to-date repo # ensure you have an up-to-date repo
git checkout develop # use master if you're doing a hotfix release git checkout develop # use stable if you're doing a hotfix release
git pull git pull
# compile changelog # compile changelog
@ -775,11 +775,11 @@ To make a new 3.4 release::
# publish # publish
git push --tags && git push git push --tags && git push
# if you're doing a hotfix release from master # if you're doing a hotfix release from stable
git checkout develop && git merge master && git push git checkout develop && git merge stable && git push
# if you're doing a non-hotfix release, and a real release (not a real release) from develop # if you're doing a non-hotfix release, and a real release (not a real release) from develop
git checkout master && git merge develop && git push git checkout stable && git merge develop && git push
Then, visit https://dev.funkwhale.audio/funkwhale/funkwhale/-/tags, copy-paste the changelog on the corresponding Then, visit https://dev.funkwhale.audio/funkwhale/funkwhale/-/tags, copy-paste the changelog on the corresponding
tag, and announce the good news ;) tag, and announce the good news ;)

1
changes/changelog.d/1476.misc Normal file
View File

@ -0,0 +1 @@
Create stable branch, master is now deprecated and will be removed in 1.3 (#1476)

12
docs/conf.py
View File

@ -58,8 +58,8 @@ templates_path = ["_templates"]
# source_suffix = ['.rst', '.md'] # source_suffix = ['.rst', '.md']
source_suffix = ".rst" source_suffix = ".rst"
# The master toctree document. # The root toctree document.
master_doc = "index" root_doc = "index"
# General information about the project. # General information about the project.
year = datetime.datetime.now().year year = datetime.datetime.now().year
@ -113,7 +113,7 @@ html_context = {
"gitlab_host": "dev.funkwhale.audio", "gitlab_host": "dev.funkwhale.audio",
"gitlab_repo": "funkwhale", "gitlab_repo": "funkwhale",
"gitlab_user": "funkwhale", "gitlab_user": "funkwhale",
"gitlab_version": "master", "gitlab_version": "stable",
"conf_py_path": "/docs/", "conf_py_path": "/docs/",
"gitlab_url": "https://dev.funkwhale.audio/funkwhale/funkwhale", "gitlab_url": "https://dev.funkwhale.audio/funkwhale/funkwhale",
} }
@ -152,7 +152,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, "funkwhale.tex", "funkwhale Documentation", "Eliot Berriot", "manual") (root_doc, "funkwhale.tex", "funkwhale Documentation", "The Funkwhale Collective", "manual")
] ]
@ -160,7 +160,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "funkwhale", "funkwhale Documentation", [author], 1)] man_pages = [(root_doc, "funkwhale", "funkwhale Documentation", [author], 1)]
# -- Options for Texinfo output ------------------------------------------- # -- Options for Texinfo output -------------------------------------------
@ -170,7 +170,7 @@ man_pages = [(master_doc, "funkwhale", "funkwhale Documentation", [author], 1)]
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
( (
master_doc, root_doc,
"funkwhale", "funkwhale",
"funkwhale Documentation", "funkwhale Documentation",
author, author,

2
docs/index.rst
View File

@ -1,4 +1,4 @@
.. funkwhale documentation master file, created by .. funkwhale documentation root file, created by
sphinx-quickstart on Sun Jun 25 18:49:23 2017. sphinx-quickstart on Sun Jun 25 18:49:23 2017.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.

6
docs/installation/debian.rst
View File

@ -140,10 +140,10 @@ Then we will download the frontend files:
cd /srv cd /srv
rm -r funkwhale rm -r funkwhale
git clone -b master https://dev.funkwhale.audio/funkwhale/funkwhale funkwhale git clone -b stable https://dev.funkwhale.audio/funkwhale/funkwhale funkwhale
cd funkwhale cd funkwhale
The above clone command uses the master branch instead of the default develop branch, as master is stable and more suited for production setups. The above clone command uses the stable branch instead of the default develop branch, as stable is stable and more suited for production setups.
You'll also need to re-create the folders we make earlier:: You'll also need to re-create the folders we make earlier::
@ -210,7 +210,7 @@ Download the sample environment file:
.. parsed-literal:: .. parsed-literal::
curl -L -o config/.env "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/master/deploy/env.prod.sample" curl -L -o config/.env "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/stable/deploy/env.prod.sample"
.. note:: .. note::

2
docs/users/cli.rst
View File

@ -21,7 +21,7 @@ Installation
We provide a prebuilt binary for Linux:: We provide a prebuilt binary for Linux::
curl -L "https://dev.funkwhale.audio/funkwhale/cli/-/jobs/artifacts/master/raw/funkwhale?job=build-linux" -o /usr/local/bin/funkwhale curl -L "https://dev.funkwhale.audio/funkwhale/cli/-/jobs/artifacts/stable/raw/funkwhale?job=build-linux" -o /usr/local/bin/funkwhale
chmod +x /usr/local/bin/funkwhale chmod +x /usr/local/bin/funkwhale
You can also install from source with:: You can also install from source with::