From 7138035b4cac890a1026551c97891cae0891bf36 Mon Sep 17 00:00:00 2001 From: Felix Cremer Date: Wed, 22 Oct 2025 09:45:43 +0200 Subject: [PATCH 1/2] Switch master to main in CI and docs --- .github/workflows/CI.yml | 2 +- .github/workflows/Documenter.yml | 6 +++--- .github/workflows/IntegrationTest.yml | 2 +- README.md | 2 +- docs/make.jl | 4 ++-- docs/src/.vitepress/config.mts | 10 +++++----- docs/src/UserGuide/group.md | 2 +- docs/src/development/contribute.md | 4 ++-- docs/src/index.md | 2 +- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 43a2b7639..3fd2b5f15 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -3,7 +3,7 @@ on: pull_request: push: branches: - - master + - main tags: - '*' jobs: diff --git a/.github/workflows/Documenter.yml b/.github/workflows/Documenter.yml index 416373ba7..2bd930b28 100644 --- a/.github/workflows/Documenter.yml +++ b/.github/workflows/Documenter.yml @@ -3,11 +3,11 @@ name: Documenter on: - # Runs on pushes targeting the `main` branch. Change this to `master` if you're - # using the `master` branch as the default branch. + # Runs on pushes targeting the `main` branch. Change this to `main` if you're + # using the `main` branch as the default branch. push: branches: - - master + - main tags: ['*'] pull_request: diff --git a/.github/workflows/IntegrationTest.yml b/.github/workflows/IntegrationTest.yml index 6681b887a..a92e631a8 100644 --- a/.github/workflows/IntegrationTest.yml +++ b/.github/workflows/IntegrationTest.yml @@ -1,7 +1,7 @@ name: IntegrationTest on: push: - branches: [master] + branches: [main] tags: [v*] pull_request: diff --git a/README.md b/README.md index 85c4fae50..9283dcbaf 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ [docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg [docs-stable-url]: https://JuliaDataCubes.github.io/YAXArrays.jl/stable/ -[codecov-img]: https://codecov.io/gh/JuliaDataCubes/YAXArrays.jl/branch/master/graph/badge.svg +[codecov-img]: https://codecov.io/gh/JuliaDataCubes/YAXArrays.jl/branch/main/graph/badge.svg [codecov-url]: https://codecov.io/gh/JuliaDataCubes/YAXArrays.jl [ci-img]: https://github.com/JuliaDataCubes/YAXArrays.jl/workflows/CI/badge.svg diff --git a/docs/make.jl b/docs/make.jl index cb18026ab..c06f6673a 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -8,7 +8,7 @@ makedocs(; sitename="YAXArrays.jl", checkdocs=:all, format=DocumenterVitepress.MarkdownVitepress( repo = "github.com/JuliaDataCubes/YAXArrays.jl", # this must be the full URL! - devbranch = "master", + devbranch = "main", devurl = "dev"; ), draft=false, @@ -21,6 +21,6 @@ DocumenterVitepress.deploydocs(; repo="github.com/JuliaDataCubes/YAXArrays.jl.git", # this must be the full URL! target=joinpath(@__DIR__, "build"), branch = "gh-pages", - devbranch="master", + devbranch="main", push_preview = true ) \ No newline at end of file diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts index cc37e2b6a..e77e43860 100644 --- a/docs/src/.vitepress/config.mts +++ b/docs/src/.vitepress/config.mts @@ -42,10 +42,10 @@ const navTemp = { { text: 'ESDL studies', items: [ - { text: 'ESDL study 1', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl/blob/master/docs/src/tutorials/esdl/examples_from_esdl_study_1.jl' }, - { text: 'ESDL study 2', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl/blob/master/docs/src/tutorials/esdl/examples_from_esdl_study_2.jl' }, - { text: 'ESDL study 3', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl/blob/master/docs/src/tutorials/esdl/examples_from_esdl_study_3.jl' }, - { text: 'ESDL study 4', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl/blob/master/docs/src/tutorials/esdl/examples_from_esdl_study_4.jl' }, + { text: 'ESDL study 1', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl/blob/main/docs/src/tutorials/esdl/examples_from_esdl_study_1.jl' }, + { text: 'ESDL study 2', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl/blob/main/docs/src/tutorials/esdl/examples_from_esdl_study_2.jl' }, + { text: 'ESDL study 3', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl/blob/main/docs/src/tutorials/esdl/examples_from_esdl_study_3.jl' }, + { text: 'ESDL study 4', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl/blob/main/docs/src/tutorials/esdl/examples_from_esdl_study_4.jl' }, ] }, { text: 'Other Tutorials', link: '/tutorials/other_tutorials' }, @@ -177,7 +177,7 @@ export default defineConfig({ }, ], editLink: { - pattern: 'https://github.com/JuliaDataCubes/YAXArrays.jl/edit/master/docs/src/:path' + pattern: 'https://github.com/JuliaDataCubes/YAXArrays.jl/edit/main/docs/src/:path' }, socialLinks: [ // { icon: 'github', link: 'https://github.com/JuliaDataCubes/YAXArrays.jl' } diff --git a/docs/src/UserGuide/group.md b/docs/src/UserGuide/group.md index 7f6b2074a..d5eaa47f7 100644 --- a/docs/src/UserGuide/group.md +++ b/docs/src/UserGuide/group.md @@ -20,7 +20,7 @@ Where the goal is to calculate the seasonal average. And in order to do this pro ### Download the data ````@example compareXarray -url_path = "https://github.com/pydata/xarray-data/raw/master/rasm.nc" +url_path = "https://github.com/pydata/xarray-data/raw/main/rasm.nc" filename = Downloads.download(url_path, "rasm.nc") ds_o = Cube(filename) ```` diff --git a/docs/src/development/contribute.md b/docs/src/development/contribute.md index b8babc789..a74692dc2 100644 --- a/docs/src/development/contribute.md +++ b/docs/src/development/contribute.md @@ -4,7 +4,7 @@ Pull requests and bug reports are always welcome at the [YAXArrays.jl GitHub rep ## Contribute to Documentation -Contributing with examples can be done by first creating a new file example [here](https://github.com/JuliaDataCubes/YAXArrays.jl/tree/master/docs/examples/UserGuide) +Contributing with examples can be done by first creating a new file example [here](https://github.com/JuliaDataCubes/YAXArrays.jl/tree/main/docs/examples/UserGuide) ::: info new file - `your_new_file.md` at `docs/src/UserGuide/` @@ -12,7 +12,7 @@ Contributing with examples can be done by first creating a new file example [her ::: -Once this is done you need to add a new entry [here](https://github.com/JuliaDataCubes/YAXArrays.jl/blob/master/docs/src/.vitepress/config.mts) at the appropriate level. +Once this is done you need to add a new entry [here](https://github.com/JuliaDataCubes/YAXArrays.jl/blob/main/docs/src/.vitepress/config.mts) at the appropriate level. ::: info add entry to docs diff --git a/docs/src/index.md b/docs/src/index.md index 445260417..50c9a754c 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -54,7 +54,7 @@ pkg> add YAXArrays If you want to use the latest unreleased version, you can run the following command: ```julia -pkg> add YAXArrays#master +pkg> add YAXArrays#main ``` ## Want interoperability? From 644547b253fd9e8606e438aef65f1ec155bc4de3 Mon Sep 17 00:00:00 2001 From: Lazaro Alonso Date: Wed, 22 Oct 2025 10:33:23 +0200 Subject: [PATCH 2/2] Update docs/src/UserGuide/group.md back to `master` --- docs/src/UserGuide/group.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/UserGuide/group.md b/docs/src/UserGuide/group.md index d5eaa47f7..7f6b2074a 100644 --- a/docs/src/UserGuide/group.md +++ b/docs/src/UserGuide/group.md @@ -20,7 +20,7 @@ Where the goal is to calculate the seasonal average. And in order to do this pro ### Download the data ````@example compareXarray -url_path = "https://github.com/pydata/xarray-data/raw/main/rasm.nc" +url_path = "https://github.com/pydata/xarray-data/raw/master/rasm.nc" filename = Downloads.download(url_path, "rasm.nc") ds_o = Cube(filename) ````