Skip to content

Commit

Permalink
Maintenance: Remove references to master branch
Browse files Browse the repository at this point in the history
Related to: #2840
  • Loading branch information
ann0see committed Dec 26, 2022
1 parent 33c7286 commit dd01e00
Show file tree
Hide file tree
Showing 14 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ assignees: ''

<!--
List possible approaches with pros and cons, reference any relevant discussion threads if possible, and consider tagging the main participants.
Please note the contribution guidelines (https://github.com/jamulussoftware/jamulus/blob/master/CONTRIBUTING.md), especially the part about "keeping it simple and stupid".
Please note the contribution guidelines (https://github.com/jamulussoftware/jamulus/blob/main/CONTRIBUTING.md), especially the part about "keeping it simple and stupid".
-->

<!-- Describe the solution you'd like -->
Expand Down
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ CHANGELOG: <!-- Insert a short, end-user understandable sentence in past tense r

<!-- Please tick the check boxes when done by replacing the space by an x, e.g. [x]. -->

- [ ] I've verified that this Pull Request follows the [general code principles](https://github.com/jamulussoftware/jamulus/blob/master/CONTRIBUTING.md#jamulus-projectsource-code-general-principles)
- [ ] I've verified that this Pull Request follows the [general code principles](https://github.com/jamulussoftware/jamulus/blob/main/CONTRIBUTING.md#jamulus-projectsource-code-general-principles)
- [ ] I tested my code and it does what I want
- [ ] My code follows the [style guide](https://github.com/jamulussoftware/jamulus/blob/master/CONTRIBUTING.md#source-code-consistency) <!-- You can also check if your code passes clang-format -->
- [ ] My code follows the [style guide](https://github.com/jamulussoftware/jamulus/blob/main/CONTRIBUTING.md#source-code-consistency) <!-- You can also check if your code passes clang-format -->
- [ ] I waited some time after this Pull Request was opened and all GitHub checks completed without errors. <!-- GitHub doesn't run these checks for new contributors automatically. -->
- [ ] I've filled all the content above

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/autobuild.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# for every push to a branch starting with "autobuild": (can be used during development for tighter supervision of builds)
# - do CodeQl while building for every platform
# - publish the created binaries/packs only as artifacts/appendix of the github-action-run (not as release), and only retain those files for limited period
# for every pull-request to master:
# for every pull-request to main:
# - do CodeQl while building for every platform
# - publish the created binaries/packs only as artifacts/appendix of the github-action-run (not as release), and only retain those files for limited period
# for every tag that starts with 'r' and has an arbitrary suffix (e.g. beta1, rc1, etc.)
Expand All @@ -29,8 +29,8 @@ on:
# For developers: Branches starting with autobuild will be built and evaluated on each push.
- "autobuild**"
# CodeQL requires every branch from on.pull_request to be part of on.push as well in order to run comparisons.
# We also need master here to trigger builds on PR merge to master and manual pushes (e.g. as part of the release process):
- "master"
# We also need main here to trigger builds on PR merge to main and manual pushes (e.g. as part of the release process):
- "main"
paths-ignore:
- '**README.md'
- 'docs/**'
Expand All @@ -43,7 +43,7 @@ on:
- '.github/pull_request_template.md'
pull_request:
branches:
- master
- main
paths-ignore:
- '**README.md'
- 'docs/**'
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/bump-dependencies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ on:

# For rebasing:
push:
branches: [master]
branches: [main]

permissions:
pull-requests: write
Expand Down Expand Up @@ -151,7 +151,7 @@ jobs:
gh pr comment "${existing_pr}" --body "PR has been updated for version *${upstream_version}* by the workflow *${GITHUB_WORKFLOW}* (*${GITHUB_JOB}*)."
fi
else
gh pr create --base master --head "${pr_branch}" --title "${pr_title}" --body "${body}"
gh pr create --base main --head "${pr_branch}" --title "${pr_title}" --body "${body}"
echo 'When Github actions create a PR, no workflows/checks (e.g. autobuilds) run.'
echo 'We do want autobuilds though, therefore, we push a slightly modified commit via the deploy key, which avoids this problem.'
echo 'We have to wait some time in order to trigger a new event... Waiting 60sec now'
Expand All @@ -171,7 +171,7 @@ jobs:
# consequences when extending these steps:
# https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
- uses: actions/checkout@v3
# this checks out the upstream `master` and not the PR branch; this is fine for us
# this checks out the upstream `main` and not the PR branch; this is fine for us
# as we just need a proper config for git/gh to work with.
- env:
pr_branch: ${{ github.event.pull_request.head.ref }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-json-rpcs-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ permissions: {}
on:
pull_request:
branches:
- master
- main
paths:
- 'tools/generate_json_rpc_docs.py'
- 'src/*rpc*.cpp'
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/coding-style-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ name: Coding Style Check
on:
workflow_dispatch:
push:
branches: [ master ]
branches: [ main ]
paths:
- '**.cpp'
- '**.h'
- '**.mm'
- '**.sh'
pull_request:
branches: [ master ]
branches: [ main ]
paths:
- '**.cpp'
- '**.h'
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/update-copyright-notices.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ permissions: {}
on:
push:
branches:
- master
- main
pull_request:
types:
- closed
Expand Down Expand Up @@ -38,7 +38,7 @@ jobs:
body=$'This automated Pull Request updates the copyright notices throughout the source.\n\n'
body="${body}This PR is the result of a tools/update-copyright-notices.sh run."$'\n\n'
body="${body}CHANGELOG: SKIP"
gh pr create --base master --head "${pr_branch}" --title "Update copyright notice(s) for $(date +%Y)" --body "${body}"
gh pr create --base main --head "${pr_branch}" --title "Update copyright notice(s) for $(date +%Y)" --body "${body}"
fi
delete-old-pr-branch:
Expand Down
2 changes: 1 addition & 1 deletion COMPILING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Jamulus can be compiled for Linux, Windows and macOS. However, the preferred method of supporting these platforms is to use the [binaries generated by the autobuild process](https://github.com/jamulussoftware/jamulus/releases/latest) in the Jamulus repository.
- For unattended installs, see the contributed [installation scripts](https://github.com/jamulussoftware/installscripts)
- The [Autobuild scripts](https://github.com/jamulussoftware/jamulus/tree/master/.github/autobuild) although only optimized to be used by the CI, might help you understand the process of setting up a build environment
- The [Autobuild scripts](https://github.com/jamulussoftware/jamulus/tree/main/.github/autobuild) although only optimized to be used by the CI, might help you understand the process of setting up a build environment
- There are reports from people who successfully compile and run Jamulus on BSDs.
- Android and iOS are not officially supported. However, [binaries are generated by the autobuild process](https://github.com/jamulussoftware/jamulus/releases/latest) in the Jamulus repository.

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Instabilities during live performances such as WorldJam are not acceptable. As a

### 2. [Keep it Simple and Stupid](https://en.wikipedia.org/wiki/KISS_principle) and 3. [Do One Thing and Do It Well](https://en.wikipedia.org/wiki/Unix_philosophy#Do_One_Thing_and_Do_It_Well)

If a feature or function can be accomplished in another way by another system or method, it is preferable not to build that feature into Jamulus. Rather than implementing each and every feature as part of Jamulus, we concentrate on a stable core and implement interfaces for interaction with third-party components as needed. The [JSON-RPC](https://github.com/jamulussoftware/jamulus/blob/master/docs/JSON-RPC.md) API for example, allows you to communicate with the client and server from outside the application.
If a feature or function can be accomplished in another way by another system or method, it is preferable not to build that feature into Jamulus. Rather than implementing each and every feature as part of Jamulus, we concentrate on a stable core and implement interfaces for interaction with third-party components as needed. The [JSON-RPC](https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON-RPC.md) API for example, allows you to communicate with the client and server from outside the application.

### Source code consistency

Please install and run `clang-format` on your PC **before committing** to maintain a consistent coding style. You should use the version we use to validate the style in our CI [(see our coding-style-check file and look for the `clangFormatVersion`)](https://github.com/jamulussoftware/jamulus/blob/master/.github/workflows/coding-style-check.yml#L20). Our CI will fail and tell you about styling violations.
Please install and run `clang-format` on your PC **before committing** to maintain a consistent coding style. You should use the version we use to validate the style in our CI [(see our coding-style-check file and look for the `clangFormatVersion`)](https://github.com/jamulussoftware/jamulus/blob/main/.github/workflows/coding-style-check.yml#L20). Our CI will fail and tell you about styling violations.

There are several ways to run clang-format:

Expand All @@ -32,7 +32,7 @@ There are several ways to run clang-format:

#### Style definition

Please see the [.clang_format file](https://github.com/jamulussoftware/jamulus/blob/master/.clang-format) in the root folder. In summary:
Please see the [.clang_format file](https://github.com/jamulussoftware/jamulus/blob/main/.clang-format) in the root folder. In summary:

- Respect the existing code style: Tab size=4, insert spaces.

Expand Down Expand Up @@ -89,7 +89,7 @@ If you are a first-time contributor/translator, please add your name to the cont

### Merging pull requests

The git master branch is protected and requires at least two reviews by the main developers before the pull request can be merged. Any of the main developers can initiate the merge if a pull request receives at least two positive reviews.
The git main branch is protected and requires at least two reviews by the main developers before the pull request can be merged. Any of the main developers can initiate the merge if a pull request receives at least two positive reviews.

---

Expand Down
2 changes: 1 addition & 1 deletion ChangeLog
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@

### 3.9.0 (2022-07-29) ###

- Feature: Added **_EXPERIMENTAL_** new JSON-RPC interface to control client and server (see [docs/JSON-RPC.md](https://github.com/jamulussoftware/jamulus/blob/master/docs/JSON-RPC.md) for details) (#1975, #2505).
- Feature: Added **_EXPERIMENTAL_** new JSON-RPC interface to control client and server (see [docs/JSON-RPC.md](https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON-RPC.md) for details) (#1975, #2505).
(contributed by @dtinth, @Rob-NY)

- GUI: Translations have been updated:
Expand Down
18 changes: 9 additions & 9 deletions docs/TRANSLATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The translator must be able to carry out the following steps, each of which are
- Copy ("clone") their own repository to their computer, using either:
- Command line `git`, or
- [GitHub Desktop](https://docs.github.com/en/desktop)
- Update their own local repo from the upstream master branch.
- Update their own local repo from the upstream main branch.
- Create a local branch to contain the update.
- Use the Qt Linguist tool to edit the appropriate translation (`.ts`) file.
- Commit the updated `.ts` file to the branch their own local git repo.
Expand Down Expand Up @@ -151,23 +151,23 @@ Instructions for use are in the [Qt Linguist Manual](https://doc.qt.io/qt-5/qtli

#### With git command line tools

The first step is to get the local repo up to date with the upstream master:
The first step is to get the local repo up to date with the upstream main:

```
cd projectdir/jamulus
git fetch upstream
```

This fetches information about the current state of the upstream repo. It is now necessary to apply any upstream changes to the local repo.
As the user will not be updating the `master` branch themselves, `git rebase` can be used to fast-forward to the current state:
As the user will not be updating the `main` branch themselves, `git rebase` can be used to fast-forward to the current state:

```
git checkout master
git rebase upstream/master
git checkout main
git rebase upstream/main
git push
```

Finally, create a new branch for the changes that will be done (do not just do them on `master`).
Finally, create a new branch for the changes that will be done (do not just do them on `main`).
The actual name of the branch is not critical, since the branch will be deleted after being merged,
but it's worth choosing a meaningful name:

Expand All @@ -181,7 +181,7 @@ The branch will be used later as the source of a pull request.

#### With GitHub Desktop

Select the current repository as `jamulus`, and the current branch as `master`.
Select the current repository as `jamulus`, and the current branch as `main`.

Click on "Fetch origin" to get fully up to date with upstream.

Expand Down Expand Up @@ -255,7 +255,7 @@ Other contributors may have edited your files after you began your work, which c
git remote add upstream git@github.com:jamulussoftware/jamulus ;# add the main repo as upstream remote if you didn’t already as mentioned above
git fetch upstream ; # Get the latest changes from the main upstream repo you added before (if needed)
git checkout <theBranchYourWorkIsOn> ;# switch to (= checkout) the branch you want to rebase
git rebase upstream/master ;# replay (=rebase) your changes onto the latest code (and fix conflicts if needed)
git rebase upstream/main ;# replay (=rebase) your changes onto the latest code (and fix conflicts if needed)
git rebase --continue # to continue the rebasing progress after having fixed the conflicts
git push --force # Push the changes to your repo. Be aware that this will overwrite your remote branch!
```
Expand All @@ -269,7 +269,7 @@ Please open an issue on GitHub and introduce yourself first, even if you intend

After having opened an issue on GitHub:
1. Fork the Jamulus repository as described above, then install Qt on your machine (See [COMPILING.md](../COMPILING.md)). (You will need `lrelease` and `lupdate` later on.)
2. Create a branch based on the `master` branch: Locally navigate to the folder you cloned the repo to (with `cd /path/to/jamulus/repo`) and type `git checkout -b "translate-add-xx_YY"` (where xx_YY is the language code of the new language).
2. Create a branch based on the `main` branch: Locally navigate to the folder you cloned the repo to (with `cd /path/to/jamulus/repo`) and type `git checkout -b "translate-add-xx_YY"` (where xx_YY is the language code of the new language).
3. Open Jamulus.pro in an editor such as `nano`: `nano Jamulus.pro` and add your language file (which will be created later) in alphabetical order to the `TRANSLATIONS` variable. The format should match the other present languages.
4. Also add `src/translation/translation_xx_YY.qm` to the DISTFILES variable similar to the other files
5. Save and close Jamulus.pro.
Expand Down
2 changes: 1 addition & 1 deletion linux/Jamulus.1
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ controlling the
verbose
.Fl \-ctrlmidich
documentation and other more or less useful information
.It Pa https://github.com/jamulussoftware/jamulus/blob/master/docs/JSON\-RPC.md
.It Pa https://github.com/jamulussoftware/jamulus/blob/main/docs/JSON\-RPC.md
JSON-RPC API Documentation (see
.Fl \-jsonrpcport
above)
Expand Down
4 changes: 2 additions & 2 deletions tools/changelog-helper.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ find_or_add_missing_entries() {
check_or_add_pr "$id"
done

local target_ref=origin/master
local target_ref=origin/main
if git tag | grep -qxF "${target_release_tag}"; then
# already released, use this
target_ref="${target_release_tag}"
fi
echo
echo "Checking if all PR references in git log since ${prev_release_tag} are included for ${target_release} based on ref ${target_ref}..."
local milestone
for id in $(git log "${prev_release_tag}..master" | grep -oP '#\K(\d+)'); do
for id in $(git log "${prev_release_tag}..main" | grep -oP '#\K(\d+)'); do
gh pr view "${id}" --json title &> /dev/null || continue # Skip non-PRs
milestone=$(gh pr view "${id}" --json milestone --jq .milestone.title)
if [[ "${milestone}" =~ "Release " ]] && [[ "${milestone}" != "Release ${target_release}" ]]; then
Expand Down
4 changes: 2 additions & 2 deletions tools/create-translation-issues.sh
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ We are getting ready for the ${RELEASE} release. No further changes to translata
We would be happy if you updated the Jamulus software translations for **${LANG}** by **${DEADLINE}**.
Please either [update the translations on Hosted Weblate](https://hosted.weblate.org/projects/jamulus/) or use Git:
- Update your fork from `jamulussoftware/jamulus` `master` and create a working branch
- Update your fork from `jamulussoftware/jamulus` `main` and create a working branch
- Update translations using Qt Linguist in your fork,
- Commit and push your changes and reference this Issue,
- Open a Pull Request before ${DEADLINE}
Expand All @@ -83,7 +83,7 @@ Fixes #<Insert this issue'"'"'s number here>
${EXTRA_TEXT}${MULTIPLE_TRANSLATORS_TEXT}
Further documentation can be found in [TRANSLATING.md](https://github.com/jamulussoftware/jamulus/blob/master/docs/TRANSLATING.md).
Further documentation can be found in [TRANSLATING.md](https://github.com/jamulussoftware/jamulus/blob/main/docs/TRANSLATING.md).
Thanks for contributing to Jamulus!
Expand Down

0 comments on commit dd01e00

Please sign in to comment.