Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 0 additions & 96 deletions .circleci/config.yml

This file was deleted.

6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ close a related issues using keywords (https://help.github.com/articles/closing-
of the person or team responsible for reviewing proposed changes. -->

## PR Checklist
- [ ] No [API changes](https://github.com/InsightSoftwareConsortium/ITK/blob/master/CONTRIBUTING.md#breaking-changes) were made (or the changes have been approved)
- [ ] No [major design changes](https://github.com/InsightSoftwareConsortium/ITK/blob/master/CONTRIBUTING.md#design-changes) were made (or the changes have been approved)
- [ ] No [API changes](https://github.com/InsightSoftwareConsortium/ITK/blob/main/CONTRIBUTING.md#breaking-changes) were made (or the changes have been approved)
- [ ] No [major design changes](https://github.com/InsightSoftwareConsortium/ITK/blob/main/CONTRIBUTING.md#design-changes) were made (or the changes have been approved)
- [ ] Added test (or behavior not changed)
- [ ] Updated API documentation (or API not changed)
- [ ] Added [license](https://github.com/InsightSoftwareConsortium/ITK/blob/master/Utilities/KWStyle/ITKHeader.h) to new files (if any)
- [ ] Added [license](https://github.com/InsightSoftwareConsortium/ITK/blob/main/Utilities/KWStyle/ITKHeader.h) to new files (if any)
- [ ] Added Python wrapping to new files (if any) as described in [ITK Software Guide](https://itk.org/ItkSoftwareGuide.pdf) Section 9.5
- [ ] Added [ITK examples](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples) for all new major features (if any)

Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/first-interaction.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:

**Welcome to the ITK community!** 🤗👋☀️

We are glad you are here and appreciate your contribution. Please keep in mind our [community participation guidelines](https://github.com/InsightSoftwareConsortium/ITK/blob/master/CODE_OF_CONDUCT.md). 📜
We are glad you are here and appreciate your contribution. Please keep in mind our [community participation guidelines](https://github.com/InsightSoftwareConsortium/ITK/blob/main/CODE_OF_CONDUCT.md). 📜
Also, please check [existing open issues](https://github.com/InsightSoftwareConsortium/ITK/issues) and consider discussion on the [ITK Discourse](https://discourse.itk.org). 📖

This is an automatic message. Allow for time for the ITK community to be able to read the issue and comment on it.
Expand All @@ -30,8 +30,8 @@ jobs:

**Welcome to the ITK community!** 🤗👋☀️

We are glad you are here and appreciate your contribution. Please keep in mind our [community participation guidelines](https://github.com/InsightSoftwareConsortium/ITK/blob/master/CODE_OF_CONDUCT.md). 📜
More support and guidance on the contribution process can be found in our [contributing guide](https://github.com/InsightSoftwareConsortium/ITK/blob/master/CONTRIBUTING.md). 📖
We are glad you are here and appreciate your contribution. Please keep in mind our [community participation guidelines](https://github.com/InsightSoftwareConsortium/ITK/blob/main/CODE_OF_CONDUCT.md). 📜
More support and guidance on the contribution process can be found in our [contributing guide](https://github.com/InsightSoftwareConsortium/ITK/blob/main/CONTRIBUTING.md). 📖

This is an automatic message. Allow for time for the ITK community to be able to read the pull request and comment
on it.
2 changes: 1 addition & 1 deletion .github/workflows/macos-arm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: ITK.macOS.Arm64
on:
push:
branches:
- master
- main
- 'release*'
paths-ignore:
- '*.md'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pixi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: ITK.Pixi
on:
push:
branches:
- master
- main
- 'release*'
paths-ignore:
- '*.md'
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/scorecard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
schedule:
- cron: '42 23 * * 6'
push:
branches: [ "master" ]
branches: [ "main" ]

# Declare default permissions as read only.
permissions: read-all
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ repos:
exclude: "\\/ThirdParty\\/"
args: ['--pytest-test-first']
- id: no-commit-to-branch
args: ['--branch','dashboard','--branch','python-builds','--branch','release','--branch','hooks','--branch', 'main','--branch','master','--pattern','release-*']
args: ['--branch','dashboard','--branch','python-builds','--branch','release','--branch','hooks','--branch', 'main','--branch','main','--pattern','release-*']
- id: trailing-whitespace
exclude: "\\.(sha|sha512|svg|vtk|vtp)$|\\/ThirdParty\\/|\\/Data\\/"
- repo: https://github.com/BlankSpruce/gersemi
Expand Down
42 changes: 21 additions & 21 deletions Documentation/Maintenance/Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Release Life Cycle
------------------

The first release candidate (RC) is the initial branch point, so it does not have
special steps to create. However, as `master` moves fairly quickly, branches
special steps to create. However, as `main` moves fairly quickly, branches
need to be corralled into the `release` branch afterwards.

When releasing a new ITK version, the following steps are be taken:
Expand Down Expand Up @@ -118,12 +118,12 @@ This ITK [blog post] describes the Linux distributions that package ITK.
Integrate bug fixes in the release branch
-----------------------------------------

Update `master` and `release` branches:
Update `main` and `release` branches:

```bash
git fetch upstream
git checkout master
git reset --hard upstream/master
git checkout main
git reset --hard upstream/main
git checkout release
git reset --hard upstream/release
```
Expand All @@ -146,10 +146,10 @@ Merge bug fix commits in release. The topic branch should be named
`<bug-name>-for-release`:
* If topic branch was created from the `release` branch, `checkout` topic
in new branch.
* If topic branch was created on `master`, `cherry-pick` commit (see
* If topic branch was created on `main`, `cherry-pick` commit (see
command line on [GitHub]) on a topic branch created off `release`. The
commit will be visible twice in the history once release in merged into
`master`.
`main`.
* Merge new branch on `release`:

```bash
Expand All @@ -171,12 +171,12 @@ The following must be ensured before tagging the ITK repository:
### Increment the version number

If the version number in `ITK/CMake/itkVersion.cmake` is not already set accordingly,
submit a pull request to update ITK's version number in the `master` branch to
what the new release is called. Any point beyond that in the `master` branch
submit a pull request to update ITK's version number in the `main` branch to
what the new release is called. Any point beyond that in the `main` branch
could serve as the start of the new release branch.

After creating the release branch, submit another merge request to update the
master branch's minor version number.
main branch's minor version number.

Update Zenodo Citation Configuration
------------------------------------
Expand Down Expand Up @@ -339,7 +339,7 @@ maintainers after an ITK Confab.
Use the command:

```bash
git checkout master
git checkout main
git pull
```

Expand All @@ -350,7 +350,7 @@ tree that has been fully tested in the [Dashboard].
bump the `ITK_VERSION_PATCH` variable in the `CMake/itkVersion.cmake`
file before tagging.
* When tagging a **feature release**, make sure to bump the
`ITK_VERSION_MINOR` version on the `master` branch after tagging.
`ITK_VERSION_MINOR` version on the `main` branch after tagging.

### Tag with a branch point reference

Expand All @@ -377,22 +377,22 @@ Note that only trusted GPG key holders may do this step.
### Update the release branch

Update the `release` branch only during feature releases after the tag for the
release. Perform a `fast-forward` merge of `master` into release:
release. Perform a `fast-forward` merge of `main` into release:

```bash
git checkout release
git reset --hard upstream/release
git merge --ff-only v$version
git push upstream release
git checkout master
git checkout main
```

This will not create a new commit, only move the release branch to the tag,
i.e. it will be fast forwarded.

For minor releases, merge the release branch into `master` branch as for a
For minor releases, merge the release branch into `main` branch as for a
normal commit, and resolve conflicts (arising from mismatch in version number)
by keeping `master` branch versions.
by keeping `main` branch versions.

Merge the `release` branch into the current named `$major_minor` version branch, e.g. `5.4`.

Expand Down Expand Up @@ -424,14 +424,14 @@ the latest ITK tag, the following steps should be performed:

1. Update the ITK tag used in the `azure-pipelines.yml` CI configuration and
the `setup.py` Python setup files, and update the remote module Python package
version to a new major version using the [UpdateRequiredITKVersionInRemoteModules.sh](https://github.com/InsightSoftwareConsortium/ITK/tree/master/Utilities/Maintenance/UpdateRequiredITKVersionInRemoteModules.sh)
version to a new major version using the [UpdateRequiredITKVersionInRemoteModules.sh](https://github.com/InsightSoftwareConsortium/ITK/tree/main/Utilities/Maintenance/UpdateRequiredITKVersionInRemoteModules.sh)
script. This will involve merging a new pull request to each remote module
repository.

2. Upload the new remote module Python wheel to [PyPI].

3. Update the remote modules to their latest commits using the
[UpdateRemoteModules.sh](https://github.com/InsightSoftwareConsortium/ITK/tree/master/Utilities/Maintenance/UpdateRemoteModules.sh)
[UpdateRemoteModules.sh](https://github.com/InsightSoftwareConsortium/ITK/tree/main/Utilities/Maintenance/UpdateRemoteModules.sh)
script.


Expand Down Expand Up @@ -525,7 +525,7 @@ documentation for further information.

First, merge the
[ITKPythonPackage](https://github.com/InsightSoftwareConsortium/ITKPythonPackage)
`master` branch into the `release` branch.
`main` branch into the `release` branch.

Next, update the `VERSION` variable in *ITKPythonPackage/itkVersion.py* and
`ITK_GIT_TAG` in *ITKPythonPackage/CMakeLists.txt*. Commit the update locally
Expand Down Expand Up @@ -792,7 +792,7 @@ version in `Superbuild/External-ITK.cmake`.
Update the CMake minimum version in the example files if necessary.

Rendered versions can be downloaded from the recent `build-test-publish`
[Documentation GitHub Artifact](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/actions/workflows/build-test-publish.yml?query=branch%3Amaster).
[Documentation GitHub Artifact](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/actions/workflows/build-test-publish.yml?query=branch%3Amain).
These should be added to a new GitHub Release on the ITKSphinxExamples
repository with the tag `v$version`.

Expand All @@ -818,7 +818,7 @@ Release Notes Posts
-------------------

To get started with the release notes, first use the download link
cookiecutter to generate [download page](https://github.com/InsightSoftwareConsortium/ITK/blob/master/Documentation/docs/download.md) markdown:
cookiecutter to generate [download page](https://github.com/InsightSoftwareConsortium/ITK/blob/main/Documentation/docs/download.md) markdown:

```bash
pip install cookiecutter
Expand Down Expand Up @@ -956,7 +956,7 @@ For the final release, the release notes produced should be used to
* Provide the release notes in the [ITK GitHub Releases]
* Post a message in the [ITK discussion]
* Create a post in the [Kitware blog]
* Add a release note doc in [ITK/Documentation/ReleaseNotes](https://github.com/InsightSoftwareConsortium/ITK/tree/master/Documentation/ReleaseNotes)
* Add a release note doc in [ITK/Documentation/ReleaseNotes](https://github.com/InsightSoftwareConsortium/ITK/tree/main/Documentation/ReleaseNotes)
* Update [ITK's Wikipedia page](https://en.wikipedia.org/wiki/Insight_Segmentation_and_Registration_Toolkit).
* Send out a summary to Arliss <help@numfocus.org> at NumFOCUS to announce
the release in the NumFOCUS project update monthly newsletter.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ These are the sources for the [ITK docs](https://docs.itk.org)
The contribution process generally follows our [contributing
guidelines](./contributing/index.md).

Once merged into `master`, the documentation will be available in the `latest`
Once merged into `main`, the documentation will be available in the `latest`
version of the ReadTheDocs documentation as https://docs.itk.org/. Note that
`latest` is not the default version (`release` is). To change versions, use the links in the lower
left of the page.
Expand Down
6 changes: 3 additions & 3 deletions Documentation/docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# https://www.sphinx-doc.org/en/main/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
# https://www.sphinx-doc.org/en/main/usage/configuration.html#project-information

import os
from datetime import date
Expand Down Expand Up @@ -58,6 +58,6 @@
html_theme_options = {
"top_of_page_button": "edit",
"source_repository": "https://github.com/InsightSoftwareConsortium/ITK/",
"source_branch": "master",
"source_branch": "main",
"source_directory": "Documentation/docs",
}
Binary file modified Documentation/docs/contributing/GitCheatSheet.pdf
Binary file not shown.
6 changes: 3 additions & 3 deletions Documentation/docs/contributing/GitCheatSheet.tex
Original file line number Diff line number Diff line change
Expand Up @@ -78,18 +78,18 @@ \subsection*{Create and Configure Your Repository}
\subsection*{Topic Branch Lifecycle}
\begin{category}{Update}
\parbox[t]{0.6\cvmain}{%
\texttt{git status\\ git checkout master\\ git pull --rebase upstream master}
\texttt{git status\\ git checkout main\\ git pull --rebase upstream main}
}
\parbox[t]{0.38\cvmain}{%
Review local modifications, delete, stash or commit them.
}
\end{category}
\begin{category}{New Topic Branch}
\parbox[t]{0.6\cvmain}{%
\texttt{git checkout -b my-topic upstream/master}
\texttt{git checkout -b my-topic upstream/main}
}
\parbox[t]{0.38\cvmain}{%
Create branch off master.
Create branch off main.
}
\end{category}
\begin{category}{Write Code}
Expand Down
4 changes: 2 additions & 2 deletions Documentation/docs/contributing/code_of_conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -429,8 +429,8 @@ modification from
* [Python](https://www.python.org/psf/codeofconduct/)
* [Django](https://www.djangoproject.com/conduct/reporting/)
* [Scipy](https://docs.scipy.org/doc/scipy//reference/dev/conduct/code_of_conduct.html)
* [Nipype](https://github.com/nipy/nipype/blob/master/CODE_OF_CONDUCT.md)
* [Jupyter](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md)
* [Nipype](https://github.com/nipy/nipype/blob/main/CODE_OF_CONDUCT.md)
* [Jupyter](https://github.com/jupyter/governance/blob/main/conduct/code_of_conduct.md)
* [The Linux Foundation](https://www.linuxfoundation.org/events/code-of-conduct/)
* [Ubuntu](https://www.ubuntu.com/about/about-ubuntu/conduct)
* [Brainhack](https://www.brainhack.org/code-of-conduct.html)
Expand Down
2 changes: 1 addition & 1 deletion Documentation/docs/contributing/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Discussion
An ITK test data file is not stored in the main source tree under version
control. Instead the source tree contains a "content link" that refers to a
data object by a hash of its content. At build time the the
[`ExternalData.cmake`](https://github.com/InsightSoftwareConsortium/ITK/blob/master/CMake/ExternalData.cmake)
[`ExternalData.cmake`](https://github.com/InsightSoftwareConsortium/ITK/blob/main/CMake/ExternalData.cmake)
module fetches data needed by enabled tests. This allows arbitrarily large data
to be added and removed without bloating the version control history.

Expand Down
Loading
Loading